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

    List applications

    Retrieves a list of applications.


    HTTP request

    GET https://gate.sendbird.com/api/v2/applications
    

    Parameters

    The following table lists the parameters that this action supports.

    Optional
    Parameter nameTypeDescription

    limit

    int

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

    offset

    int

    Specifies the number of results to skip when receiving a response. The value of offset is also used as the starting index of each page. (Default: 0)

    region_key

    string

    Specifies the code of the region. Acceptable values are listed on the Sendbird Dashboard under the account's Organization settings > General > API key. Only the owner of the organization can view the region keys.

    ?limit=3&offset=3
    

    Response

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

    {
        "count": 40,
        "previous": "https://gate.sendbird.com/api/v2/applications?limit=3&offset=3",
        "next": "https://gate.sendbird.com/api/v2/applications?limit=3&offset=6",
        "results": [
            {
                "app_id": "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "app_name": "sendbird_application_staging",
                "api_token": "80af23e7ec3a51fa2792c249aaf9e8f1e5bd4a6c",
                "region": {
                    "region_key": "tokyo-1",
                    "region_name": "Tokyo, Japan"
                },
                "created_at": "2020-10-13T06:10:59Z"
            },
            ... # More applications
        ]
    }
    

    List of response properties

    Property nameTypeDescription

    count

    int

    The total count of applications in an organization.

    previous

    string

    The URL to retrieve the previous page in a result set.

    next

    string

    The URL to retrieve the next page in a result set.

    results[]

    array of objects

    An array of applications.

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