Contact

List contacts

Get contacts for the customer.

get/contacts

Query parameters

page_sizeinteger
Example:25

Number of results to return per page.

page_tokenstring

Cursor token for pagination. Use the next_page_token value from the previous response.

Response

Successful response.

next_page_tokenstring

Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.

Example response

{
  "result": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "first_name": "John",
      "last_name": "Smith",
      "display_name": "John Smith",
      "company": "Acme Corporation",
      "job_title": "Software Engineer",
      "source": "manual",
      "external_id": "CRM-12345",
      "notes": "Prefers morning calls. VIP account - escalate to senior support immediately.",
      "addresses": [
        {
          "type": "tel",
          "target": "+14155551234",
          "target_name": "John Smith",
          "name": "Main Office",
          "detail": "Primary contact number",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "contact_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
          "customer_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "is_primary": true,
          "tm_create": "2026-01-15T09:30:00.000000Z"
        }
      ],
      "tag_ids": [
        "b1a2c3d4-e5f6-7890-abcd-ef1234567890"
      ],
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}

Changes

Changed in 6 of the 54 revisions of this API.1115

    • added the new web_session enum value to the allOf[subschema #2]/result/items/addresses/items/allOf[CommonAddress]/type response property for the response status 200

      response-property-enum-value-added

    • added the optional property allOf[subschema #2]/result/items/notes to the response with the 200 status

      response-optional-property-added

  • 2ad05734434b151See the full diff
    • the allOf[subschema #2]/result/items/addresses/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the optional property allOf[subschema #2]/result/items/addresses/items/id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property allOf[subschema #2]/result/items/addresses/items/is_primary from the response with the 200 status

      response-optional-property-removed

    • removed the optional property allOf[subschema #2]/result/items/addresses/items/target from the response with the 200 status

      response-optional-property-removed

    • removed the optional property allOf[subschema #2]/result/items/addresses/items/tm_create from the response with the 200 status

      response-optional-property-removed

    • removed the optional property allOf[subschema #2]/result/items/addresses/items/type from the response with the 200 status

      response-optional-property-removed

    • added CommonAddress subschema #2 to the allOf[subschema #2]/result/items/addresses/items/ response property allOf list for the response status 200

      response-property-all-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a689a640736021See the full diff
    • removed the optional property allOf[subschema #2]/result/items/emails from the response with the 200 status

      response-optional-property-removed

    • removed the optional property allOf[subschema #2]/result/items/phone_numbers from the response with the 200 status

      response-optional-property-removed

    • added the optional property allOf[subschema #2]/result/items/addresses to the response with the 200 status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the optional property allOf[subschema #2]/result/items/phone_numbers/items/number_e164 from the response with the 200 status

      response-optional-property-removed

  • 995c56ba921922See the full diff
    • removed the optional property allOf[subschema #2]/result/items/addresses from the response with the 200 status

      response-optional-property-removed

    • removed the optional property allOf[subschema #2]/result/items/notes from the response with the 200 status

      response-optional-property-removed

    • added the optional property allOf[subschema #2]/result/items/emails to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #2]/result/items/phone_numbers to the response with the 200 status

      response-optional-property-added

    This revision also has 20 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog