Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API
    /
    Bot

    List bots

    Retrieves a list of all bots within an application.


    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/bots
    

    Parameters

    The following table lists the parameters that this action supports.

    Optional
    Parameter nameTypeDescription

    token

    string

    Specifies a page token that indicates the starting index of results to retrieve. If not specified, the index is set to 0.

    limit

    int

    Specifies the number of bots to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)


    Response

    If successful, this action returns a list of bot resources in the response body.

    {
        "bots": [
            {
                "bot": {
                    "bot_userid": "lunch_helper_bot",
                    "bot_nickname": "Lunch helper",
                    "bot_type": "marketer",
                    "bot_profile_url": "https://mealadvisor.com/bots/img/sendbird_01_512px.png",
                    "bot_token": "753afa86d980feea00657f040535fe4f73755e05",
                    "bot_metadata": {}
                },
                "bot_callback_url": "https://mealadvisor.com/bots/sendbird/lunch/",
                "enable_mark_as_read": true,
                "is_privacy_mode": false,
                "show_member": false,
                "channel_invitation_preference": 0
            },
            ... # More bots
        ],
        "next": "FdW6RsFRQ1ArRafXA1RcE2d0FUZSUlkJFdeRHB863DAgNn8eDRS3dBNFX11fUlsDRs3E"
    }
    

    List of response properties

    Property nameTypeDescription

    bots[]

    array of objects

    An array of bots.

    next

    string

    The value that can be used in the token parameter to retrieve the next page in the result set.

    In the case of an error, an error object is returned. A detailed list of error codes is available here.