live-chat
GET /v1/chat/widgets/{widgetId}
One chat's settings and its AI allowance.
Authentication
Send an API key as a bearer token. The key must carry the livechat.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Requires `livechat.view` or `livechat.manage`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
widgetId (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
site_id | string | Yes | — |
name | string | Yes | — |
public_key | string | Yes | — |
enabled | boolean | Yes | Whether the chat renders. Created FALSE always: the plugin ships in the deploy footprint of every WordPress site we host, so a widget may exist for a customer who never asked fo… |
allowed_origins | string[] | Yes | Origins the widget may be embedded on. An EMPTY list refuses every page rather than allowing any — this is the only control stopping somebody else's site opening conversations a… |
tier | string | Yes | — |
greeting | string | Yes | — |
team_name | string | Yes | — |
accent_colour | string | Yes | — |
position | string<left, right> | Yes | — |
hide_branding | boolean | Yes | — |
ai_enabled | boolean | Yes | — |
offline_email | string | Yes | — |
business_hours | object | No | — |
open_now | boolean | Yes | — |
ai_allowance | ChatAiAllowance | Yes | — |
limits | object | Yes | — |
premium_extra_code | string | Yes | The catalogue code to buy for the premium tier. |
Errors this endpoint can return
401 · 403 · 404