Get Pending Contracts

get

https://api.zylo.com/v2/pendingContracts

Required Permissions

contracts:read

Rate Limit

basic

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

billing_frequency

string

How often billing occurs (e.g., monthly, annually).

cancellation_policy

string

The cancellation policy for the pending contract.

company_document_id

string

The company document associated with this pending contract.

contract_term

string

Contract term type (Fixed, Auto-renewed, or Perpetual).

created_by

string

Who uploaded the contract document.

end_date

string

Pending contract end date. May be null for ongoing contracts.

string

Unique identifier for the pending contract.

is_reviewed

boolean

Whether the AI-extracted data has been reviewed by a human.

month_to_month

boolean

Whether this is a recurring payment contract.

name

string

Name of the pending contract, typically derived from the uploaded document filename.

native_currency

string

Currency the pending contract was made out for.

native_total_contract_value

string

Estimated total value of the pending contract in native currency.

notification_period

string

Required notification period before contract changes.

number

string

Pending contract number extracted from the document.

owner

string

Person responsible for administering the pending contract.

source

string

The source of the contract data (e.g., API, manual upload).

start_date

string

Pending contract start date.

supplier_id

string

The supplier associated with this pending contract.

zylo_created_at

string

Date and time the pending contract was created (upload date).

zylo_modified_at

string

Date and time the pending contract was last modified.

sort

string

Defaults to +zylo_created_at

Sort by any non-object or array value. Use +/- to indicate direction.

limit

double

≤ 1000

Defaults to 50

Number of results to bring back.

skip

double

Defaults to 0

Offset the results by this number.

cursor

string

id value to use cursor based pagination. Can be used in place of skip.

string

Search the results by this string.

Response

200Ok