get
Get widget configuration
Retrieves widget configuration.
Widget Management
| Endpoint | /widgets/{token} |
| Method | get |
| Plan Required | FREE |
| Authorization | Bearer Token required |
| Permissions | None |
| Content-Type | application/json |
/widgets/{token}application/jsonAPI Tester(Loading...)
Loading API token configuration...
Payload
URL Parameters
tokenstringrequiredWidget token
Response
200Widget configuration
| Field | Type | Description / Example |
|---|---|---|
| id | number | No example |
| color | string | No example |
| buttonClass | string | No example |
| chatClass | string | No example |
| chatTitleClass | string | No example |
| chatInputClass | string | No example |
| buttonXPos | number | No example |
| buttonYPos | number | No example |
| buttonBgColor | string | No example |
| buttonTextColor | string | No example |
| bubbleColor | string | No example |
| bubbleTextColor | string | No example |
| websiteClientToken | string | No example |
| chatFormFields | string | No example |
| welcomeMessages | string | No example |
| ratingEnabled | boolean | No example |
| removeBranding | boolean | No example |
| chatEnabled | boolean | No example |
id
No example
color
No example
buttonClass
No example
chatClass
No example
chatTitleClass
No example
chatInputClass
No example
buttonXPos
No example
buttonYPos
No example
buttonBgColor
No example
buttonTextColor
No example
bubbleColor
No example
bubbleTextColor
No example
websiteClientToken
No example
chatFormFields
No example
welcomeMessages
No example
ratingEnabled
No example
removeBranding
No example
chatEnabled
No example
400Bad request - Invalid token
No response details available
404Widget not found
No response details available
Expected Response
JSON
{
"id": "abc123def456",
"color": "sample_color",
"buttonClass": "sample_buttonClass",
"chatClass": "sample_chatClass",
"chatTitleClass": "Software Engineer",
"chatInputClass": "sample_chatInputClass",
"buttonXPos": 42,
"buttonYPos": 42,
"buttonBgColor": "sample_buttonBgColor",
"buttonTextColor": "Sample text content",
"bubbleColor": "sample_bubbleColor",
"bubbleTextColor": "Sample text content",
"websiteClientToken": "sk-abc123def456ghi789",
"chatFormFields": "sample_chatFormFields",
"welcomeMessages": "Hello, this is a test message",
"ratingEnabled": true,
"removeBranding": true,
"chatEnabled": true
}API Access Token
Base URL
https://api.5chat.io