Search for messages

Search for messages by filtering on properties, searching through associations, and sorting results. Learn more about CRM search.

post/crm/v3/objects/communications/search

Request body

afterstring required

A paging cursor token for retrieving subsequent pages.

limitinteger required

The maximum results to return, up to 200 objects.

propertiesstring[] required

A list of property names to include in the response.

querystring

The search query string, up to 3000 characters.

sortsstring[] required

Specifies sorting order based on object properties.

Response

successful operation

totalinteger required

The number of available results

Example response

{
  "paging": {
    "next": {
      "after": "NTI1Cg%3D%3D",
      "link": "?after=NTI1Cg%3D%3D"
    }
  },
  "results": [
    {
      "archived": false,
      "createdAt": "2019-10-30T03:30:17.883Z",
      "id": "512",
      "properties": {
        "property_checkbox": "false",
        "property_date": "1572480000000",
        "property_dropdown": "choice_b",
        "property_multiple_checkboxes": "chocolate;strawberry",
        "property_number": "17",
        "property_radio": "option_1",
        "property_string": "value"
      },
      "updatedAt": "2019-12-07T16:50:06.678Z"
    }
  ]
}

Changes

Changed in 9 of the 56 revisions of this API.712

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, 2026v305374d334cfc31See the full diff
- ▲
  removed the enum value BETWEEN(VALUE of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value HIGH_VALUE) of the request property ////
  request-property-enum-value-removed
- ▲
  the / request property type changed from object to string
  request-property-type-changed
- ○
  added the new BETWEEN enum value to the request property ////
  request-property-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 15, 2026v3f24577fd501d22See the full diff
- ▲
  removed the enum value BETWEEN of the request property ////
  request-property-enum-value-removed
- ▲
  the / request property type changed from string to object
  request-property-type-changed
- ○
  added the new BETWEEN(VALUE enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new HIGH_VALUE) enum value to the request property ////
  request-property-enum-value-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