---
title: "List bots"
method: GET
path: "/v3/bots"
tags: ["Bot"]
---

# List bots

`GET /v3/bots`

## Request

- Base URL: `https://api-APP_ID.sendbird.com`
- URL: `https://api-APP_ID.sendbird.com/v3/bots`
- Auth: none declared

## List bots

Retrieves a list of all bots within an application.

https://sendbird.com/docs/chat/platform-api/v3/bot/listing-bots/list-bots#1-list-bots

## Query parameters

- `token` string
- `limit` integer

## Headers

- `api-token` string

## Response `200`

Successful response

- ListBotsResponse
  - `bots` ListBotsResponseBotsInner[]
    - `bot` ListBotsResponseBotsInnerBot
      - `ai_agent_type` string
      - `bot_metadata` object
      - `bot_nickname` string
      - `bot_profile_url` string
      - `bot_require_auth_for_profile_image` boolean
      - `bot_token` string
      - `bot_type` string
      - `bot_userid` string, required
    - `bot_callback_url` string
    - `bot_style` ListBotsResponseBotsInnerBotStyle
      - `auto_open` boolean
      - `color` ListBotsResponseBotsInnerBotStyleColor
        - `accent_color` string
        - `bot_message_color` string
        - `theme` string
      - `toggle_button_type` string, nullable
      - `toggle_button_url` string, nullable
    - `channel_invitation_preference` integer
    - `created_at` integer
    - `enable_mark_as_read` boolean
    - `first_messages` ListBotsResponseBotsInnerFirstMessagesInner[]
      - `data` ListBotsResponseBotsInnerFirstMessagesInnerData
        - `suggested_replies` string[]
      - `message` string
    - `is_privacy_mode` boolean
    - `safeguard` ListBotsResponseBotsInnerSafeguard
      - `banned_phrases` unknown[]
        - unknown
      - `enabled` boolean
      - `message` string
      - `pii_masking` boolean
    - `show_member` boolean
  - `next` string

## Changes

- **2025-10-17** `b05d4e3c6329`: 1 warning
  - removed the optional property `bots/items/ai` from the response with the `200` status
- **2025-07-27** `7a85bad03e90`: 1 warning, 9 info
  - deleted the `header` request parameter `Api-Token`
  - added the new optional `header` request parameter `api-token`
  - added the optional property `bots/items/ai` to the response with the `200` status
  - added the optional property `bots/items/bot/ai_agent_type` to the response with the `200` status
  - …6 more
- **2023-11-10** `135d8b0705d4`: 1 info
  - the `header` request parameter `Api-Token` became optional
- **2022-06-29** `4012275aa67d`: 2 info
  - api tag `Bot` added
  - api tag `Bot interface` removed
- **2022-02-16** `c42164095c7c`: 1 breaking
  - the `header` request parameter `Api-Token` became required

[Operation history](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/changes/v3/bots/get.md)

---

[API](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk.md) - [All operations](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/llms.txt) - [OpenAPI document](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/revisions/9e53a5288df0?raw)
