List Chat Widgets

GET 
/chat-widget/list

Retrieves a list of chat widgets for a specific location

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

The location ID

offset stringrequired

Row offset. Defaults to 0, capped at 10000.

limit stringrequired

Page size. Must be greater than 0, capped at 100.

chatType string

The type of chat widget. Supports normal ChatType values, plus the virtual umbrella "webChat" (maps to facebookChat/emailChat/instagramChat/waChat).

Available optionsliveChatwaChatemailChatallInOneChatvoiceAiChatfacebookChatinstagramChatwebChat

excludeChatType string

The type of chat widget

Available optionsliveChatwaChatemailChatallInOneChatvoiceAiChatfacebookChatinstagramChat

voiceAiAgentId string

The voice AI agent ID

creationSource string

The source that created the widget

Available optionschat-widgeta2pCompliancepublic-apisnapshot

excludeCreationSource string

Exclude widgets with this creation source

Available optionschat-widgeta2pCompliancepublic-apisnapshot

application/json

Success

application/json

Schema

Schema

chatWidgetsobject[]required

Matching chat widgets for this page

totalCountnumberrequired

Total widgets matching the filters, ignoring limit and offset

Example (auto)

{
  "chatWidgets": [
    {
      "_id": "ve9EPM428h8vShlRWsss",
      "name": "Chat Widget 1",
      "chatType": "emailChat",
      "default": false,
      "creationSource": "chat-widget",
      "settings": {
        "legalMsg": "By submitting you agree to our terms.",
        "advanceSettings": {}
      },
      "createdAt": "2026-08-14T02:37:09.128Z",
      "updatedAt": "2026-08-18T07:21:26.939Z"
    }
  ],
  "totalCount": 42
}