Skip to main content
POST
List bots
Required scopes: agents-bot--my:ro,

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
all
boolean
default:false

If set to true: returns all bots within the license. If set to false: returns only the requester's bots.

fields
enum<string>[]

Additional bot fields to include in the response.

  • groups — The groups a bot belongs to.
  • work_scheduler — The work scheduler object for a bot.
  • job_title — The bot's job title.
  • max_chats_count — The bot's maximum number of concurrent chats.
  • timezone — The time zone in which the bot's work scheduler operates.
Available options:
groups,
work_scheduler,
job_title,
max_chats_count,
timezone

Response

200 - application/json

A list of bots.

id
string

The bot ID.

name
string

The display name.

avatar_path
string

The URL of the bot's avatar.