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.

The response is the raw, unmodified peer_events shape (design doc 2026-07-25-contact-interaction-retire-to-peer-events, §8.1/§9): rows may include internal-resource peer types (agent, ai, conference, sip legs) with no CRM eligibility filtering or field reshaping applied.

get/contact_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": [
    {
      "timestamp": "2026-01-15T10:30:00.123000Z",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "publisher": "call",
      "event_type": "call_hangup",
      "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "direction": "incoming",
      "peer": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "local": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "data": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    }
  ],
  "next_page_token": "2026-01-15T10:30:00.123000Z"
}

Changes

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

Jul 26, 2026d5569b3154112See the full diff
- ●
  added the new web_session enum value to the result/items/local/allOf[CommonAddress]/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new web_session enum value to the result/items/peer/allOf[CommonAddress]/type response property for the response status 200
  response-property-enum-value-added
Jul 24, 2026fe81b36d2a0454See the full diff
- ●
  removed the optional property result/items/id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property result/items/reference_type from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property result/items/tm_create from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property result/items/tm_interaction from the response with the 200 status
  response-optional-property-removed
- ●
  added the new enum value to the result/items/direction response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property result/items/data to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property result/items/event_type to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property result/items/publisher to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property result/items/timestamp to the response with the 200 status
  response-optional-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 20266bba44d87e8342See the full diff
- ●
  removed the optional property result/items/local_target from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property result/items/local_type from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property result/items/peer_target from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property result/items/peer_type from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property result/items/local to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property result/items/peer to the response with the 200 status
  response-optional-property-added
Jul 8, 20260e81fffc28491See the full diff
- ○
  endpoint added
  endpoint-added
May 30, 2026995c56ba92191See 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

Full history