Skip to main content
GET
Show

Authorizations

X-API-KEY
string
header
required

Your API key for authentication.

x-org-id
string
header
required

Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.

Path Parameters

widget_config_id
string
required
Required string length: 24

Response

Successful Response

account_id
string
required
campaign_id
string
required
Required string length: 24
id
string | null
name
string
default:Chat Widget
version
enum<string>
default:v1

Version of the widget configuration schema

Available options:
v1,
v2
enabled
boolean
default:true
agent_id
string | null
Required string length: 24
session_timeout_minutes
integer
default:30
Required range: 1 <= x <= 1440
inactivity_prompt_minutes
integer | null
Required range: 1 <= x <= 1440
inactivity_prompt_text
string | null
inactivity_close_minutes
integer
default:5
Required range: 1 <= x <= 1440
additional_config
Additional Config · object