SEsendbird
Bot

List bots

Changed on

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

get/v3/bots

Request

  • Base URL
    https://api-APP_ID.sendbird.com
  • Auth
    none declared

Query parameters

tokenstring
limitinteger

Headers

api-tokenstring
Example:{{API_TOKEN}}

Response

Successful response

nextstring

Example response

{
  "next": "next",
  "bots": [
    {
      "show_member": true,
      "enable_mark_as_read": true,
      "is_privacy_mode": true,
      "bot_callback_url": "bot_callback_url",
      "bot": {
        "bot_profile_url": "bot_profile_url",
        "bot_userid": "bot_userid",
        "bot_metadata": "{}",
        "bot_type": "bot_type",
        "bot_nickname": "bot_nickname",
        "bot_token": "bot_token",
        "bot_require_auth_for_profile_image": true,
        "ai_agent_type": "ai_agent_type"
      },
      "bot_style": {
        "color": {
          "accent_color": "accent_color",
          "bot_message_color": "bot_message_color",
          "theme": "theme"
        },
        "toggle_button_type": "toggle_button_type",
        "toggle_button_url": "toggle_button_url",
        "auto_open": true
      },
      "created_at": 6,
      "channel_invitation_preference": 0,
      "first_messages": [
        {
          "data": {
            "suggested_replies": [
              "suggested_replies",
              "suggested_replies"
            ]
          },
          "message": "message"
        },
        {
          "data": {
            "suggested_replies": [
              "suggested_replies",
              "suggested_replies"
            ]
          },
          "message": "message"
        }
      ],
      "safeguard": {
        "pii_masking": true,
        "banned_phrases": [
          "",
          ""
        ],
        "message": "message",
        "enabled": true
      }
    },
    {
      "show_member": true,
      "enable_mark_as_read": true,
      "is_privacy_mode": true,
      "bot_callback_url": "bot_callback_url",
      "bot": {
        "bot_profile_url": "bot_profile_url",
        "bot_userid": "bot_userid",
        "bot_metadata": "{}",
        "bot_type": "bot_type",
        "bot_nickname": "bot_nickname",
        "bot_token": "bot_token",
        "bot_require_auth_for_profile_image": true,
        "ai_agent_type": "ai_agent_type"
      },
      "bot_style": {
        "color": {
          "accent_color": "accent_color",
          "bot_message_color": "bot_message_color",
          "theme": "theme"
        },
        "toggle_button_type": "toggle_button_type",
        "toggle_button_url": "toggle_button_url",
        "auto_open": true
      },
      "created_at": 6,
      "channel_invitation_preference": 0,
      "first_messages": [
        {
          "data": {
            "suggested_replies": [
              "suggested_replies",
              "suggested_replies"
            ]
          },
          "message": "message"
        },
        {
          "data": {
            "suggested_replies": [
              "suggested_replies",
              "suggested_replies"
            ]
          },
          "message": "message"
        }
      ],
      "safeguard": {
        "pii_masking": true,
        "banned_phrases": [
          "",
          ""
        ],
        "message": "message",
        "enabled": true
      }
    }
  ]
}

Changes

  • b05d4e3c6329Revision changes
    • warning

      removed the optional property // from the response with the status

  • 7a85bad03e90Revision changes
    • warning

      deleted the header request parameter Api-Token

    • info

      added the new optional header request parameter api-token

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response property /// became required for the status