v1

latestOpenAPI 3.1.02026-07-12103663.1 KB

Contacts

List Contacts

get/unified/crm/contacts

Query parameters

rawboolean nullable

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxyobject nullable

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fieldsstring nullable

Example:id,remote_id,first_name,last_name,company_name,emails,phone_numbers,deal_ids,remote_deal_ids,account_ids,remote_account_ids,custom_fields,created_at,updated_at,unified_custom_fields

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

updated_afterstring date-time nullable

Use a string with a date to only select results updated after that given date

Filter parameters that allow greater customisation of the list response

{
  "updated_after": "2020-01-01T00:00:00.000Z"
}

pagestring nullable

The page number of the results to fetch

page_sizestring nullable

The number of results per page (default value is 25)

nextstring nullable

The unified cursor

updated_afterstring date-time nullable

Example:2020-01-01T00:00:00.000Z

Use a string with a date to only select results updated after that given date

includestring nullable

Example:custom_fields

The comma separated list of fields that will be included in the response

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Response

The list of contacts was retrieved.

next_pagestring nullable

nextstring nullable

Example response

{
  "data": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "unified_custom_fields": {
        "my_project_custom_field_1": "REF-1236",
        "my_project_custom_field_2": "some other value"
      },
      "first_name": "Steve",
      "last_name": "Wozniak",
      "company_name": "Apple Inc.",
      "emails": [
        "steve@apple.com"
      ],
      "phone_numbers": [
        "123-456-7890"
      ],
      "deal_ids": [
        "deal-001",
        "deal-002"
      ],
      "remote_deal_ids": [
        "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
      ],
      "account_ids": [
        "account-123",
        "account-456"
      ],
      "remote_account_ids": [
        "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
      ],
      "custom_fields": [
        {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "name": "Training Completion Status",
          "value_id": "value_456",
          "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
        }
      ],
      "created_at": "2021-01-01T01:01:01.000Z",
      "updated_at": "2021-01-01T01:01:01.000Z"
    }
  ]
}

All 10 operations