v51

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

Webchat

Get a list of webchat sessions.

Retrieves a paginated list of webchat sessions for the authenticated customer.

get/webchat_sessions

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.

widget_idstring uuid

Filter sessions to those belonging to this widget. Returned from the POST /webchat_widgets or GET /webchat_widgets response.

Response

A list of webchat sessions.

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": "7a1bcb1a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "widget_id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "active",
      "page_url": "https://example.com/pricing",
      "referrer": "https://example.com/blog/some-article",
      "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"
      },
      "tm_last_activity": "2026-01-15T09:30:00.000000Z",
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_end": "2026-01-15T09:30:00.000000Z"
    }
  ]
}