ghl_chat_widget_list
List chat widgets for a sub-account with pagination and optional filters such as chat type, exclusion type, or voice AI agent.
Instructions
List Chat Widgets Returns chat widgets for the sub-account with pagination and optional filters. Endpoint: GET /chat-widget/list (Version header: v3; source: v3/chat-widget-v3.json) OAuth scopes: chat-widget.readonly Pagination params: offset, limit — pass them to page through full result sets.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | Yes | Limit | |
| offset | Yes | Offset | |
| chatType | No | The type of chat widget. Supports normal ChatType values, plus the virtual umbrella "webChat" (maps to facebookChat/emailChat/instagramChat/waChat). | |
| locationId | Yes | The location ID | |
| voiceAiAgentId | No | The voice AI agent ID | |
| excludeChatType | No | The type of chat widget | |
| allInOneChatTypes | No | All-in-one chat type to filter by. Only applies when chatType is "allInOneChat". Supports normal ChatType values plus the virtual umbrella "webChat" (maps to facebookChat/emailChat/instagramChat/waChat). |