List Contracts

This endpoint fetches contract data based on filters like name, dates, status, and other contract attributes. Supports pagination and sorting.

Supported Filters:

FieldTypeDescription / Allowed Values
contract_idstringContract ID
contract_namestringContract name
contract_statusenumContract status
contract_start_datedateContract start date (ISO 8601 format, use with field_order)
contract_end_datedateContract end date (ISO 8601 format, use with field_order)
contract_renew_bydateContract renewal date (ISO 8601 format, use with field_order)
contract_cancel_bydateContract cancellation date (ISO 8601 format, use with field_order)
archivebooleanArchive status (true/false)

Date Range Filtering: For date fields, use field_order with operators:

  • gte - Greater than or equal to
  • lte - Less than or equal to
  • eq - Equal to
  • ne - Not equal to
  • lt - Less than
  • gt - Greater than

Example Date Filter:

{
  "field_id": "contract_start_date",
  "field_order": ["gte"],
  "field_values": ["2023-10-01"]
}

Custom Fields Filter Format:

{
  "field_id": "custom_fields",
  "field_values": {
    "custom_field_id": "679b613f315ee0a11cb67bd1",
    "custom_field_values": ["India"]
  }
}

Use these as field_id values inside the filter_by array in the request body to filter results. For custom fields, the field_id will always be custom_fields, while the field_values object must contain custom_field_id (the ID of the custom field) and custom_field_values (an array of values to filter by).

Language
Credentials
Header
Click Try It! to start a request and see the response here!