contracts

List of contracts

Returns a paginated list of contract summaries for the organization, with optional filtering by status, type, team, legal entity, country, currency, external ID, or a name search term. Use GET /contracts/{contract_id} to retrieve full details for a specific contract.

Token scopes: contracts:read

get/contracts

Request

  • Base URL: https://api.letsdeel.com/rest
  • URL: https://api.letsdeel.com/rest/contracts
  • Auth: HTTP bearer

Query parameters

after_cursorstring

Return next page of results after the given cursor.

limitstring

Return a page of results with the given number of records.

order_direction'asc' | 'desc'

Order direction of results; ascending or descending.

typesContractsGetParametersTypesSchemaItems[]

Filter contracts by type. A contract is included in the results if its type is in this list.

statusesContractsGetParametersStatusesSchemaItems[]

Filter contracts by current status. A contract is included in the results if its status is in this list.

string
OR
string[]

Filter contracts for the given team ID(s). A contract is included in the results if its team is in this list.

string
OR
string[]

Filter contracts for the given legal entity ID(s). A contract is included in the results if its legal entity is in this list.

external_idstring

Filter contracts for the given external ID.

external_id_absentstring

Filter contracts by external ID presence. When true, returns contracts without an external ID. When false, returns contracts with an external ID. Cannot be used with external_id query param when set to true.

countriesstring[]

Filter contracts by country codes.

currenciesstring[]

Filter contracts by currency codes.

searchstring

Include a contract if its name or the contractor's name contains the given search term.

sort_by'contract_title' | 'worker_name'

Sort contracts by the given field name.

expandContractsGetParametersExpandSchemaItems[]

Include additional fields in the response. Multiple values can be passed as comma-separated list.

Response

Successful operation.

Changes

No recorded changes to this operation across all 1 revision of this API.