v51

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

Webchat

Get a list of webchat widgets.

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

get/webchat_widgets

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.

Response

A list of webchat widgets.

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": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "name": "Support Widget",
      "status": "active",
      "session_flow_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "message_flow_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
      "session_idle_timeout": 1800,
      "theme_config": {
        "primary_color": "#1a73e8",
        "secondary_color": "#f5f5f5",
        "header_background_color": "#1a73e8",
        "header_text_color": "#ffffff",
        "logo_url": "https://cdn.example.com/logo.png",
        "position": "bottom_right",
        "theme_mode": "light",
        "header_title": "Support",
        "header_subtitle": "We usually reply in a few minutes",
        "connecting_indicator_enabled": true,
        "connecting_indicator_text": "Connecting…",
        "typing_indicator_enabled": true,
        "border_radius": "rounded",
        "font_size": "default"
      },
      "direct_hash": "a8f3b2c1d4e5",
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}