ghl_chat_widget_list
Retrieve chat widgets for a GoHighLevel location, with optional filters and offset/limit pagination to page through results.
Instructions
List Chat Widgets Retrieves a list of chat widgets for a specific location Endpoint: GET /chat-widget/list (Version header: v3; source: v3/chat-widget-v3.json) Requires a Sub-Account (location) token. OAuth scopes: chat-widget.readonly Pagination params: offset, limit — pass them to page through full result sets.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"locationId": "<locationId>",
"offset": "<offset>",
"limit": "<limit>"
},
"name": "ghl_chat_widget_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | Yes | Page size. Must be greater than 0, capped at 100. | |
| offset | Yes | Row offset. Defaults to 0, capped at 10000. | |
| 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 | |
| creationSource | No | The source that created the widget | |
| voiceAiAgentId | No | The voice AI agent ID | |
| excludeChatType | No | The type of chat widget | |
| excludeCreationSource | No | Exclude widgets with this creation source |