curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.example.com/api/widget/settings'
{
"settings": {}
}
Published widget configuration for a site or origin
Public (no widget token); rate limited. Resolves the published configuration by siteId, else by the request Origin hostname…
GET
/
api
/
widget
/
settings
curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.example.com/api/widget/settings'
{
"settings": {}
}
Public (no widget token); rate limited. Resolves the published configuration by
siteId, else by the request Origin hostname. Answers 204 with no body when the
admin database is not configured, when no configuration matches the origin, or when the
lookup fails. Responses carry Access-Control-Allow-Origin: * and
Cache-Control: public, max-age=60.
An explicit siteId with no published configuration returns 404 not_found.
Query parameters
Response
object
Published merchant configuration (the
ChatWidgetSettings shape in src/types/chat.ts, as stored by the admin API). Keys are merchant-defined; see WIDGET-CONFIGURATION.md ‘Remote Settings’.Status codes
| Code | Meaning |
|---|---|
200 | Published configuration |
204 | No configuration available for this origin (or admin DB not configured) |
404 | Unknown siteId |
429 | Too many requests for this IP (scoped by verified org/agent) |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.example.com/api/widget/settings'
{
"settings": {}
}
Last modified on November 13, 2026