v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

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"
    }
  ]
}