GEThttps://app.evoriqa.com/api/v1/chatbots/{chatbotId}/appearance

Get widget appearance

Returns the appearance bundle: the chatbot's display fields plus its widget settings, as one `{ chatbot, settings }` object.

Requires scope chatbots:read

Access is gated — enable it before your first call

The API is off by default. A request succeeds only when all three switches are on: the platform master switch (off by default), your organisation’s API toggle, and your plan or client entitlement. Any one off returns 403 API access is not enabled for this workspace.

Parameters

Name	In	Type	Required	Default	Description
chatbotId	path	string uuid	Required	—	The chatbot's id.

Request

curl

curl "https://app.evoriqa.com/api/v1/chatbots/{chatbotId}/appearance" \
  -H "x-api-key: $EVORIQA_API_KEY"

Node.js

const res = await fetch("https://app.evoriqa.com/api/v1/chatbots/{chatbotId}/appearance", {
  headers: {
    Authorization: `Bearer ${process.env.EVORIQA_API_KEY}`,
  },
});

const responseBody = await res.json();

Python

import os
import requests

res = requests.get(
    "https://app.evoriqa.com/api/v1/chatbots/{chatbotId}/appearance",
    headers={"Authorization": f"Bearer {os.environ['EVORIQA_API_KEY']}"},
)

body = res.json()

Response

200 OK

{
  "success": true,
  "data": {
    "chatbot": {
      "botName": "Ava",
      "greetingMessage": "Hi! How can I help?"
    },
    "settings": {
      "primaryColor": "#4373fc",
      "position": "bottom-right",
      "showPoweredBy": true,
      "collectLeads": true,
      "leadCaptureMode": "on_handoff",
      "suggestedQuestions": [
        "What does it cost?",
        "How do I get started?"
      ],
      "placeholderText": "Ask a question...",
      "proactiveEnabled": false,
      "aiDisclosureEnabled": true
    }
  }
}