Skip to main content
contract_types

List /contract_types

List contract types (optional query matches name and code_name). Each item includes uuid, code_name, name and contract_prefix. The uuid is what the contract type field expects. Response: items and pagination.

GET
/contract_types
Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

querystringquery

Optional search phrase (matches name and code_name).

Minimum string length: 1
pageintegerquery

Page number (1-based).

Required range: 1 <= x
per_pageintegerquery

Number of results per page. limit is accepted as an alias.

Required range: 1 <= x <= 500
sortstringquery

Optional sort order, comma-separated; prefix a field with - for descending (e.g. sort=-updated_at); empty values sort last. Sortable fields: code_name, contract_prefix, name, uuid. Default when omitted: id.

fieldsstring[]query

Optional response field paths (dot notation for nested groups, e.g. billing_address.street; array fields are returned whole). Comma-separated string is also accepted. Identifier field is always included.

Response

application/json

Search results

itemsobject[]
paginationobject
querystring