Skip to main content
GET
/
platform
/
api
/
v1
/
agent_bots
List all AgentBots
curl --request GET \
  --url https://app.chatwoot.com/platform/api/v1/agent_bots \
  --header 'api_access_token: <api-key>'
[
  {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "thumbnail": "<string>",
    "outgoing_url": "<string>",
    "bot_type": "<string>",
    "bot_config": {},
    "account_id": 123,
    "access_token": "<string>",
    "system_bot": true
  }
]

Authorizations

​
api_access_token
string
header
required

This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.

Response

Success

Array of agent bots

​
id
number

ID of the agent bot

​
name
string

The name of the agent bot

​
description
string

The description about the agent bot

​
thumbnail
string

The thumbnail of the agent bot

​
outgoing_url
string

The webhook URL for the bot

​
bot_type
string

The type of the bot

​
bot_config
object

The configuration of the bot

​
account_id
number

Account ID if it's an account specific bot

​
access_token
string

The access token for the bot

​
system_bot
boolean

Whether the bot is a system bot

⌘I