List contracts

Returns a list of contracts in the organization.

Filtering is available via the documented query parameters below and by custom contract fields.

Example:

GET /contracts?fields=id,name,idApp,myCustomField&status=active&myCustomField=true

The above example returns a list of contracts that are in active status and myCustomField is true. Each contract object will contain the id, name, idApp and myCustomField fields.

Multi Currency Support: All currency fields are returned in their original amounts based on the contract currency. To get the contract currency, add currency to fields.

Example:

GET /contracts?fields=id,name,amount,currency

  • Rate limit: 100 requests per minute

Query Params
string
Defaults to id,name,idApp,owner

List of fields to return for each contract.
Allowed fields: id, idApp, name, owner, status, createdBy and all fields from /contracts/fields

Response

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*