Basic

List

Read a page of contracts. Control what is returned via the properties query param.

get/crm/v3/objects/contracts

Query parameters

afterstring

The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results.

archivedboolean

Whether to return only results that have been archived.

associationsstring[]

A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.

limitinteger

The maximum number of results to display per page.

propertiesstring[]

A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.

propertiesWithHistorystring[]

A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of contracts that can be read by a single request.

Response

successful operation

Example response

{
  "paging": {
    "next": {
      "after": "NTI1Cg%3D%3D",
      "link": "?after=NTI1Cg%3D%3D"
    }
  }
}

Changes

Changed in 7 of the 56 revisions of this API.2110

Jul 13, 2026v3fb2da1434d001See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 23, 2026v38c459c7adcf81See the full diff
- ○
  added the optional property results/items/warnings to the response with the 200 status
  response-optional-property-added
Jun 15, 2026v3827038b5099e11See the full diff
- ▲
  removed the required property results/items/associations/additionalProperties/results/items/associationSpec from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property results/items/associations/additionalProperties/results/items/toOffset from the response with the 200 status
  response-optional-property-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 15, 2026v32f950cda67051See the full diff
- ○
  the response property results/items/associations/additionalProperties/results/items/associationSpec became required for the status 200
  response-property-became-required
Jun 15, 2026v38fac3d8fec952See the full diff
- ○
  added the optional property results/items/associations/additionalProperties/results/items/associationSpec to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property results/items/associations/additionalProperties/results/items/toOffset to the response with the 200 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 15, 2026v36a142fabc6135See the full diff
- ○
  the endpoint scheme security oauth2 was added to the API
  api-security-added
- ○
  the endpoint scheme security app_cookie was removed from the API
  api-security-removed
- ○
  the endpoint scheme security hapikey was removed from the API
  api-security-removed
- ○
  the endpoint scheme security internal_cookie was removed from the API
  api-security-removed
- ○
  the endpoint scheme security shhkey was removed from the API
  api-security-removed
Apr 11, 2026v3ad6b00f1dceb1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history