GET
/
chatbots
curl --request GET \
  --url https://api.chat-dash.com/v1/public/chatbots \
  --header 'Authorization: <authorization>'
[
  {
    "_id": "<string>",
    "name": "<string>",
    "platform": "voiceflow",
    "apiId": "<string>",
    "apiKey": "<string>",
    "platformCredentials": {
      "botId": "<string>",
      "workspaceId": "<string>"
    },
    "usingExternalWidget": true,
    "available": true
  }
]

Headers

Authorization
string
required

All requests to the ChatDash API must be validated with the agency API Key found on your agency profile

Response

200
application/json
OK
_id
string

The ID of the chatbot

name
string

The chatbot's name

platform
enum<string>

The chatbot's platform

Available options:
voiceflow,
openai,
botpress,
vectorshift,
flowise,
vapi,
retell,
elevenlabs,
n8n,
custom
apiId
string

The 'ID' for interacting with the chatbot platform's API. Varies by platform:

  • Voiceflow: Project ID
  • OpenAI: Assistant ID
  • Botpress: Messaging API webhook URL
  • Vectorshift: Chatbot Name on VectorShift
  • Flowise: Chatflow ID
  • Vapi: Assistant ID
  • Retell: Agent ID
  • ElevenLabs: Agent ID
  • n8n: N/A
  • Custom: N/A
apiKey
string

The 'Key' for interacting with the chatbot platform's API. Varies by platform:

  • Voiceflow: Dialog API Key
  • OpenAI: API Key
  • Botpress: Personal Access Token
  • Vectorshift: API Key
  • Flowise: API Key
  • Vapi: Private API Key
  • Retell: API Key
  • ElevenLabs: API Key
  • n8n: N/A
  • Custom: N/A
platformCredentials
object

Additional credentials for interacting with certain chatbot platform's API (field only required for the specified platforms below)

usingExternalWidget
boolean

Whether the chatbot is using an external widget or interface over ChatDash's native widget. Varied support by platform:

  • Voiceflow: Supported
  • OpenAI: Supported
  • Botpress: Supported
  • Vectorshift: Not Supported
  • Flowise: Supported
  • Vapi: Supported
  • Retell: Supported
  • ElevenLabs: Required to be set to true
  • n8n: Not Supported
available
boolean

Whether the chatbot is available for use (for chatbots using external widget)