Sign in
Interaction

List interactions

List CRM interactions for the customer. Exactly one filter is required: peer_type + peer_target (remote endpoint), contact_id, or address_id.

get/interactions

Query parameters

peer_typestring
Example:tel

Remote endpoint type (e.g. "tel", "email"). Required with peer_target.

peer_targetstring
Example:+15551234567

Remote endpoint target (e.g. "+15551234567"). Required with peer_type.

contact_idstring uuid
Example:550e8400-e29b-41d4-a716-446655440000

Filter by resolved contact ID.

address_idstring uuid
Example:7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d

Filter by contact address ID.

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

Pagination token for the next page. Empty when no further pages exist.

Example response

{
  "result": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "direction": "incoming",
      "peer_type": "tel",
      "peer_target": "+155****4567",
      "local_type": "tel",
      "local_target": "+12025550100",
      "reference_type": "call",
      "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "tm_interaction": "2026-06-01T09:30:00.000000Z",
      "tm_create": "2026-06-01T09:30:01.000000Z"
    }
  ],
  "next_page_token": "2026-06-01T09:30:01.000000Z"
}

Changes