Open channel

List open channels

Changed on Oct 17, 2025

List open channels

This action retrieves a list of open channels. You can use various query parameters to determine the search scope and select what kind of information you want to receive about the queried channels.

https://sendbird.com/docs/chat/platform-api/v3/channel/listing-channels-in-an-application/list-open-channels#1-list-open-channels

get/v3/open_channels

Request

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

Query parameters

tokenstring

channel_urlsstring

Specifies a comma-separated string of one or more open channel URLs to restrict the search scope. URL encoding each channel URL is recommended.

limitinteger

custom_typesstring

Specifies a comma-separated string of one or more custom types to filter open channels. Urlencoding each type is recommended (for example, ?custom_types=urlencoded_type_1,urlencoded_type_2). If not specified, all channels are returned, regardless of their custom type.

name_containsstring

url_containsstring

show_frozenboolean

Determines whether to include frozen channels in the response. Frozen channels are channels where only channel operators are allowed to send messages. (Default: true)

show_metadataboolean

Determines whether to include channel metadata in the response. (Default: false)

Headers

api-tokenstring

Example:{{API_TOKEN}}

Response

Successful response

nextstring

tsinteger

Example response

{
  "next": "next",
  "channels": [
    {
      "cover_url": "cover_url",
      "metadata": "{}",
      "data": "data",
      "custom_type": "custom_type",
      "is_ephemeral": true,
      "created_at": 0,
      "is_dynamic_partitioned": true,
      "channel_url": "channel_url",
      "freeze": true,
      "participant_count": 1,
      "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
        }
      ],
      "max_length_message": 6,
      "name": "name"
    },
    {
      "cover_url": "cover_url",
      "metadata": "{}",
      "data": "data",
      "custom_type": "custom_type",
      "is_ephemeral": true,
      "created_at": 0,
      "is_dynamic_partitioned": true,
      "channel_url": "channel_url",
      "freeze": true,
      "participant_count": 1,
      "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
        }
      ],
      "max_length_message": 6,
      "name": "name"
    }
  ],
  "ts": 5
}

Changes

Oct 17, 2025b05d4e3c6329 Revision changes
- breaking
  the response property // became nullable for the status
- 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
Jul 27, 20257a85bad03e90 Revision changes
- warning
  deleted the header request parameter Api-Token
- warning
  deleted the query request parameter custom_type
- 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
- warning
  removed the optional property //// from the response with the status
- info
  api operation id ocListChannels removed and replaced with listOpenChannels
- info
  added the new optional header request parameter api-token
- info
  added the new optional query request parameter channel_urls
- info
  added the optional property // to the response with the status
- 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
- info
  the response property //// became required for the status

Operation history (8 revisions)

List open channels