Retrieve contracts
Retrieve all contracts in the location.
OAuth
Required scopes:invoices.readonly or invoicesAuthorizations
See our authentication documentation for how to authorize your requests
Headers
The id of the network. Required when using bearer token authentication
Query Parameters
Filter contracts created on or after this date (ISO 8601). Use with createDate[lte] for a range.
Filter contracts created on or before this date (ISO 8601). Use with createDate[gte] for a range.
UUID of the customer (membership or company). Provide customerRef or locationRef; when set, returns only that customer's contracts.
Maximum number of contracts per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.
1 <= x <= 100UUID of the location. Provide customerRef or locationRef; when set, returns contracts in that location.
Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.
Case-insensitive search by contract title. Requires customerRef or locationRef to scope the search.
Filter by contract status. Comma-separated values, e.g. draft,issued.
Supported values:
- draft — created but not sent
- issued — sent, awaiting signature
- signed — active
- declined — rejected
- terminated — cancelled after signing