Skip to main content
GET
List contracts

Authorizations

Authorization
string
header
required

An API key created in Settings, sent as Authorization: Bearer <key>.

Query Parameters

customerIds
string

Only the contracts of these customers, separated by commas.

lifecycleStatuses
string

Only contracts whose lifecycleStatus is one of these, separated by commas — for example DRAFT,ACTIVE. The statuses are DRAFT, ACTIVE, EXPIRED, CANCELLED, DELETED. Leave it out for every status but DELETED.

processingInvoices
boolean

true for only the contracts whose processingInvoices is true; false for only the rest.

startingAfter
string

The nextCursor of the previous page, to read the page after it.

Required string length: 1 - 1024
Pattern: ^[A-Za-z0-9._-]+$
endingBefore
string

The prevCursor of the previous page, to read the page before it.

Required string length: 1 - 1024
Pattern: ^[A-Za-z0-9._-]+$
limit
integer
default:50

Rows per page, 1 to 100.

Required range: 1 <= x <= 100

Response

Successful response

data
object[]
required
hasMore
boolean
required
nextCursor
string
prevCursor
string