Sign in
Contact

List contact addresses

Get a list of contact addresses. Optionally filter by contact_id and/or type.

get/contact_addresses

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.

contact_idstring uuid
Example:5e4a0680-eba3-4001-a000-000000000001

Filter by contact ID.

type'tel' | 'email' | 'web_session'
Example:tel

Filter by address type.

unresolvedboolean
Example:true

When true, list only unresolved addresses (contact_id IS NULL) for the customer — the pool of addresses not yet attached to any contact. Mutually exclusive with contact_id; if both are given, unresolved=true wins and contact_id is ignored.

targetstring
Example:+155****4567

Filter by exact address target value (E.164 for tel, email address for email).

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": [
    {
      "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"
    }
  ]
}

Changes

Changed in 5 of the 54 revisions of this API.265

  • d5569b31541112See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

      added the new optional query request parameter target

      new-optional-request-parameter

    • ○

      added the new enum value web_session to the query request parameter type

      request-parameter-enum-value-added

  • 505b7c32e9101See the full diff
    • ○

      added the new optional query request parameter unresolved

      new-optional-request-parameter

  • 2ad05734434b151See the full diff
    • ▲

      the allOf[subschema #2]/result/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/id from the response with the 200 status

      response-optional-property-removed

    • ●

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

      response-optional-property-removed

    • ●

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

      response-optional-property-removed

    • ●

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

      response-optional-property-removed

    • ●

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

      response-optional-property-removed

    • ○

      added CommonAddress subschema #2 to the allOf[subschema #2]/result/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

  • b1372a7d8ce61See the full diff
    • ○

      endpoint added

      endpoint-added

  • 995c56ba92191See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

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