Tenant settings (optional)

Fetched when settingsEndpoint is set. Send Authorization: ApiKey <key> (or Bearer <key>); x-api-key is also accepted.

GET /chat-widget/settings

cURL

curl --request GET \
  --url 'https://api.example.com/chat-widget/settings' \
  --header 'x-widget-token: YOUR_API_KEY'

200

{
  "settings": {
    "companyName": "Acme Outdoors",
    "messageEndpoint": "string",
    "theme": {
      "primary": "string",
      "secondary": "string",
      "text": "Two-person tent, green — replacement for damaged pole set.",
      "accent": "string",
      "hover": "string"
    }
  },
  "updated_at": "2026-08-31T14:22:05Z"
}

Fetched when settingsEndpoint is set. Send Authorization: ApiKey <key> (or Bearer <key>); x-api-key is also accepted.

Response

Settings

settings · object

Show settings

companyName · string

messageEndpoint · string

theme · object

Show theme

primary · string

secondary · string

text · string

accent · string

hover · string

updated_at · string (date-time)

Status codes

Code	Meaning
200	OK
400	Error
401	Error

cURL

curl --request GET \
  --url 'https://api.example.com/chat-widget/settings' \
  --header 'x-widget-token: YOUR_API_KEY'

200

{
  "settings": {
    "companyName": "Acme Outdoors",
    "messageEndpoint": "string",
    "theme": {
      "primary": "string",
      "secondary": "string",
      "text": "Two-person tent, green — replacement for damaged pole set.",
      "accent": "string",
      "hover": "string"
    }
  },
  "updated_at": "2026-08-31T14:22:05Z"
}