SEsendbird
Open channel

List operators of an open channel

Changed on

List operators of an open channel

You can retrieve a list of operators of an open channel using this API.

https://sendbird.com/docs/chat/platform-api/v3/user/assigning-a-user-role/list-operators-of-an-open-channel#1-list-operators-of-an-open-channel

channel_url
Type: string
Description: Specifies the URL of the channel to retrieve a list of operators.

get/v3/open_channels/{channel_url}/operators

Request

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

Path parameters

channel_urlstring required

(Required)

Query parameters

tokenstring
limitinteger

Headers

api-tokenstring
Example:{{API_TOKEN}}

Response

Successful response

nextstring

Example response

{
  "next": "next",
  "operators": [
    {
      "metadata": "{}",
      "require_auth_for_profile_image": true,
      "is_active": true,
      "role": "",
      "user_id": "user_id",
      "profile_url": "profile_url",
      "nickname": "nickname",
      "is_blocked_by_me": true
    },
    {
      "metadata": "{}",
      "require_auth_for_profile_image": true,
      "is_active": true,
      "role": "",
      "user_id": "user_id",
      "profile_url": "profile_url",
      "nickname": "nickname",
      "is_blocked_by_me": true
    }
  ]
}

Changes

  • b05d4e3c6329Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • info

      the response's property default value was added for the status

  • 7a85bad03e90Revision changes
    • warning

      deleted the header request parameter Api-Token

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      api operation id ocListOperators removed and replaced with listChannelOperators

    • 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

      the response property // became required for the status