/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    Organization

    List members

    Copy link

    Retrieves a list of members of an organization.

    HTTP request

    Copy link
    GET https://gate.sendbird.com/api/v2/organization_members

    Parameters

    Copy link

    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

    Copy link

    If successful, this action returns a member resource in the response body.

    {
    "count": 27,
    "previous": "https://gate.sendbird.com/api/v2/applications?limit=10&offset=0",
    "next": "https://gate.sendbird.com/api/v2/applications?limit=10&offset=20",
    "results": [
        {
            "id": 4,
            "role": "OWNER",
            "created_at": "2021-04-07T08:15:16.542515Z",
            "status": "ACTIVE",
            "user": {
                "id": 8,
                "email": "[email protected]",
                "date_joined": "2021-04-07T08:15:16.537315Z",
                "is_active": true,
                "profile": {
                    "id": 7,
                    "nickname": "sample_user_nickname"
                },
                "first_name": "",
                "last_name": ""
            },
            "organization": 5,
            "organization_member_role": {
                "name": "OWNER",
                "is_predefined": true
            }
        },
        … # More organization member data
    ]
}

    List of response properties

    Copy link
    Property nameTypeDescription

    count

    int

    The total number of members in the specified organization.

    previous

    string

    The URL to retrieve the previous page in the result set, or null if there are no previous pages available.

    next

    string

    The URL to retrieve the next page in the result set, or null if there are no more pages available.

    results[]

    array of objects

    An array of members in the specified organization.

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

    On this page
    HTTP requestParametersResponse