List contracts
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.
Query Parameters
-Optional. Default:0. Number of records you wish to skip before selecting records.
Limits the number of records returned by the api.
sort directions of the retrieved records. Default value desc
desc, asc sort field of the retrieved records. Default value updatedAt
contractId, organizationName, startDate, endDate, status, priceListId, updatedAt start date of the contracts to filter. If sent also startDateTo must be sent.
start date of the contracts to filter. If sent also startDateFrom must be sent.
end date of the contracts to filter. If sent also endDateTo must be sent.
end date of the contracts to filter. If sent also endDateFrom must be sent.
it will be compared against the name of the party of the contract or de contractId.
status of the contracts to be retrieved.
DRAFT, INACTIVE, ACTIVE -Optional. Must be used in combination with filterValue. Especifies a particular field to filter on.
-Optional. Must be used in combination with filterField. Especifies the value of the field determined in filterValue.
Response
it contains data about pagination
list of contracts to be retrieved
Was this page helpful?