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

Changes

Changed in 7 of the 54 revisions of this API.137

  • d5569b3154112See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • 205d85b460a33See the full diff
    • ○

      added the optional property allOf[subschema #2]/result/items/local to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/result/items/peer to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/result/items/referrer to the response with the 200 status

      response-optional-property-added

  • 3591c4dad5071See the full diff
    • ○

      added the optional property allOf[subschema #2]/result/items/page_url to the response with the 200 status

      response-optional-property-added

  • d90e2d9717dc1See the full diff
    • ●

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

      response-optional-property-removed

  • 37603aee58ea2See the full diff
    • ○

      added the new optional query request parameter widget_id

      new-optional-request-parameter

    • ○

      added the optional property allOf[subschema #2]/result/items/welcome_message to the response with the 200 status

      response-optional-property-added

  • 39e5a5e6214c1See 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