Basic

List

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

get/crm/v3/objects/communications

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 communications 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 10 of the 55 revisions of this API.3112

Sep 2, 2026v3a7c9a1222f8b1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 13, 2026v36a1666da27ea1See 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
Jul 13, 2026v32531fcdcdc191See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 13, 2026v369b41e2497e31See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
Jun 23, 2026v32531fcdcdc191See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Jun 15, 2026v305374d334cfc11See the full diff
- ▲
  removed the required property ////// from the response with the status
  response-required-property-removed
- ●
  removed the optional property ////// from the response with the 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, 2026v33f0c374da3ae1See the full diff
- ○
  the response property ////// became required for the status
  response-property-became-required
Jun 15, 2026v3f24577fd501d2See the full diff
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the 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, 2026v3aa87273c3f595See the full diff
- ○
  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 private_apps was removed from the API
  api-security-removed
- ○
  the endpoint scheme security shhkey was removed from the API
  api-security-removed
Apr 13, 2026v3bc2405b1d51f1See 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