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

    List custom roles

    Retrieves a list of custom roles in an organization.


    HTTP request

    GET https://gate.sendbird.com/api/v2/organization_members/custom_roles
    

    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)


    Response

    If successful, this action returns an array of customized roles in the response body.

    {
        "count": 2,
        "next": null,
        "previous": null,
        "results": [
            {
                "id": 10000,
                "name": "CUSTOM_ROLE1",
                "description": "custom role for limited member"
            },
            {
                "id": 10001,
                "name": "announcement role",
                "description": "announcement manager"
            }
        ]
    }
    

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