Skip to main content
GET
/
api
/
v1
/
widget
/
{widget_id}
Get Widget By Id
curl --request GET \
  --url 'https://api.example.com/api/v1/widget/{widget_id}?api_key='
{
  "message": "Data retrieved successfully",
  "meta": {},
  "data": {
    "widget_type": "chat",
    "user_opening_messages": [
      "<string>"
    ],
    "action_buttons": [
      "<unknown>"
    ],
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "conversation_bot_icon": "<string>",
    "bubble_bot_icon": "<string>",
    "provider_user_friendly_label": "<string>",
    "widget_provider": "<string>",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "attributes": {},
    "display_name": "<string>",
    "intro_message": "<string>",
    "header_color": "<string>",
    "user_message_color": "<string>",
    "bot_message_color": "<string>",
    "bot_icon_color": "<string>",
    "remove_branding": false,
    "ice_break_color": "<string>",
    "bubble_color": "<string>",
    "bubble_text": "<string>",
    "bot_text_message_color": "<string>",
    "user_text_message_color": "<string>",
    "header_text_color": "<string>",
    "textbox_default_text": "<string>",
    "action_buttons_color": "<string>",
    "style_params": {}
  }
}

Authorizations

​
api_key
string
query
required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Path Parameters

​
widget_id
string<uuid>
required

Response

Successful Response

​
message
string | null
default:Data retrieved successfully
​
meta
Meta · object
​
data
IWidgetRead · object