--- title: "List channels" method: GET path: "/v3/group_channels" tags: ["Group channel"] --- # List channels `GET /v3/group_channels` ## Request - Base URL: `https://api-APP_ID.sendbird.com` - URL: `https://api-APP_ID.sendbird.com/v3/group_channels` - Auth: none declared. Required headers: `api-token` ## List group channels This action retrieves a list of [group channels](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-group-channel). 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. If you want to retrieve a list of group channels that a specific user has joined, use the [list group channels by user](https://sendbird.com/docs/chat/platform-api/v3/user/managing-joined-group-channels/list-group-channels-by-user) action under the User section. https://sendbird.com/docs/chat/platform-api/v3/channel/listing-channels-in-an-application/list-group-channels#1-list-group-channels ## Query parameters - `token` string - `limit` integer - `distinct_mode` 'all' | 'distinct' | 'nondistinct': Restricts the search scope to only retrieve distinct or nondistinct group channels. Acceptable values are the following: - all (default): All group channels are returned. - distinct: Only distinct group channels are returned. - nondistinct: Only group channels that aren't distinct are returned. - `public_mode` 'all' | 'private' | 'public': Restricts the search scope to only retrieve either public or private group channels. Acceptable values are the following: - all (default): All group channels are returned. - private: All private group channels are returned. - public: All public group channels are returned. - `super_mode` 'all' | 'super' | 'nonsuper': Specifies which type of group channels to retrieve. Acceptable values are the following: - all (default): All types of group channels including Supergroup channels are returned. - super: Only Supergroup channels are returned. - nonsuper: Group channels excluding Supergroup channels are returned. - `created_after` integer - `created_before` integer - `show_empty` boolean - `show_member` boolean - `show_delivery_receipt` boolean - `show_read_receipt` boolean - `show_metadata` boolean - `show_frozen` boolean - `order` 'chronological' | 'latest_last_message' | 'channel_name_alphabetical' | 'metadata_value_alphabetical' - `metadata_order_key` string - `custom_types` string - `custom_type_startswith` string - `channel_urls` string - `name` string - `name_contains` string - `name_startswith` string - `members_exactly_in` string - `members_include_in` string - `query_type` string - `members_nickname` string - `members_nickname_contains` string - `metadata_key` string - `metadata_values` string - `metadata_value_startswith` string - `metacounter_key` string - `metacounter_values` string - `metacounter_value_gt` string - `metacounter_value_gte` string - `metacounter_value_lt` string - `metacounter_value_lte` string - `include_sorted_metaarray_in_last_message` boolean ## Headers - `api-token` string, required ## Response `200` Successful response - GroupChatListChannelsResponse - `channels` SendbirdGroupChannel[] - `channel_url` string, required - `count_preference` 'false' | 'all' | 'unread_message_count_only' | 'unread_mentioned_count_only' - `cover_url` string - `created_at` integer - `created_by` SendbirdBasicUserInfo - `require_auth_for_profile_image` boolean - `is_active` boolean - `is_blocked_by_me` boolean - `role` '' | 'none' | 'operator' - `nickname` string, nullable - `user_id` string, required - `profile_url` string - `metadata` object, nullable - `custom_type` string - `data` string - `delivery_receipt` object - `disappearing_message` SendbirdDisappearingMessage - `message_survival_seconds` integer - `is_triggered_by_message_read` boolean - `freeze` boolean - `has_ai_bot` boolean - `has_bot` boolean - `hidden_state` 'hidden_allow_auto_unhide' | 'hidden_prevent_auto_unhide' | 'unhidden' - `ignore_profanity_filter` boolean - `invited_at` integer - `inviter` SendbirdBasicUserInfo - `require_auth_for_profile_image` boolean - `is_active` boolean - `is_blocked_by_me` boolean - `role` '' | 'none' | 'operator' - `nickname` string, nullable - `user_id` string, required - `profile_url` string - `metadata` object, nullable - `is_access_code_required` boolean, nullable - `is_broadcast` boolean - `is_discoverable` boolean - `is_distinct` boolean - `is_ephemeral` boolean - `is_exclusive` boolean - `is_hidden` boolean - `is_muted` boolean - `is_public` boolean - `is_push_enabled` boolean - `is_super` boolean - `joined_member_count` integer - `joined_ts` integer, nullable - `last_message` SendbirdGroupChannelLastMessage - `require_auth` boolean - `message_survival_seconds` integer - `custom_type` string - `mentioned_users` SendbirdBasicUserInfo[] - `require_auth_for_profile_image` boolean - `is_active` boolean - `is_blocked_by_me` boolean - `role` '' | 'none' | 'operator' - `nickname` string, nullable - `user_id` string, required - `profile_url` string - `metadata` object, nullable - `translations` object - `updated_at` integer - `is_op_msg` boolean - `reactions` SendbirdReaction[] - `key` string - `updated_at` integer - `user_ids` string[] - `is_removed` boolean - `user` SendbirdBasicUserInfo - `require_auth_for_profile_image` boolean - `is_active` boolean - `is_blocked_by_me` boolean - `role` '' | 'none' | 'operator' - `nickname` string, nullable - `user_id` string, required - `profile_url` string - `metadata` object, nullable - `file` object - `files` SendbirdFile[] - `url` string - `file_name` string - `file_size` integer - `file_type` string - `thumbnails` SendbirdThumbnail[] - `height` integer - `plain_url` string - `real_height` integer - `real_width` integer - `url` string - `width` integer - `require_auth` boolean - `message` string - `data` string - `message_retention_hour` integer - `silent` boolean - `type` string - `created_at` integer - `channel_type` string - `req_id` string - `mention_type` string - `channel_url` string - `message_id` integer - `sorted_metaarray` SendbirdSortedMetaarrayInner[] - `key` string - `value` string[] - `thread_info` object - `parent_message_id` integer - `parent_message_info` SendbirdParentMessageInfo - `custom_type` string - `message` string - `type` string - `ts` integer - `user` SendbirdUser: User - `access_token` string - `created_at` integer - `discovery_keys` string[], nullable - `has_ever_logged_in` boolean - `is_active` boolean - `is_hide_me_from_friends` boolean - `is_online` boolean - `is_shadow_blocked` boolean - `last_seen_at` integer - `locale` string - `metadata` object, nullable - `nickname` string, nullable - `preferred_languages` string[], nullable - `profile_url` string - `require_auth_for_profile_image` boolean - `user_id` string, required - `state` '' | 'invited' | 'joined', nullable - `unread_channel_count` integer - `unread_message_count` integer - `phone_number` string - `is_created` boolean - `file` SendbirdFile - `url` string - `file_name` string - `file_size` integer - `file_type` string - `thumbnails` SendbirdThumbnail[] - `height` integer - `plain_url` string - `real_height` integer - `real_width` integer - `url` string - `width` integer - `require_auth` boolean - `files` SendbirdFile[] - `url` string - `file_name` string - `file_size` integer - `file_type` string - `thumbnails` SendbirdThumbnail[] - `height` integer - `plain_url` string - `real_height` integer - `real_width` integer - `url` string - `width` integer - `require_auth` boolean - `is_reply_to_channel` boolean - `message_events` SendbirdMessageResponseMessageEvents, nullable - `send_push_notification` string - `update_unread_count` boolean - `update_mention_count` boolean - `update_last_message` boolean - `extended_message_payload` SendbirdMessageResponseExtendedMessagePayload: Specifies the extended message payload which is used to send a message with a custom message type. - `custom_view` object: JSON format you want to embed in message, eq : {"title": "title", "image": "https://link.to/image.jpg"} - `suggested_replies` string[]: Specifies an array of suggested replies to be sent with the message. - `max_length_message` integer - `member_count` integer - `member_state` 'invited' | 'joined' | 'none' - `members` SendbirdMember[] - `delivered_ts` integer - `do_not_disturb` boolean - `friend_discovery_key` string[], nullable - `friend_name` string, nullable - `is_active` boolean - `is_blocked_by_me` boolean - `is_blocking_me` boolean - `is_muted` boolean - `is_online` boolean - `last_seen_at` integer - `metadata` object, nullable - `muted_description` string - `muted_end_at` integer - `nickname` string, nullable - `push_enabled` boolean - `push_trigger_option` 'all' | 'mention_only' | 'off' - `profile_url` string - `require_auth_for_profile_image` boolean - `read_ts` integer - `role` '' | 'none' | 'operator', nullable - `state` '' | 'invited' | 'joined', nullable - `user_id` string, required - `message_survival_seconds` integer - `metadata` object, nullable - `my_role` '' | 'none' | 'operator' - `name` string - `push_trigger_option` 'all' | 'mention_only' | 'off' - `read_receipt` object - `sms_fallback` SendbirdSmsFallback - `wait_seconds` integer - `exclude_user_ids` string[] - `ts_message_offset` integer - `unread_mention_count` integer - `unread_message_count` integer - `user_last_read` integer - `next` string - `ts` integer ## Changes - **2025-10-17** `2a35c3c56c0f`: 1 breaking, 1 info - added `#/components/schemas/SendbirdMessageResponse` to the `channels/items/last_message` response property `oneOf` list for the response status `200` - removed `#/components/schemas/Sendbird.MessageResponse` from the `channels/items/last_message` response property `oneOf` list for the response status `200` - **2025-10-17** `b05d4e3c6329`: 1 breaking, 1 info - added `#/components/schemas/Sendbird.MessageResponse` to the `channels/items/last_message` response property `oneOf` list for the response status `200` - removed `#/components/schemas/SendBird.MessageResponse` from the `channels/items/last_message` response property `oneOf` list for the response status `200` - **2025-10-17** `716caef6594d`: 1 breaking, 1 info - added `#/components/schemas/SendBird.MessageResponse` to the `channels/items/last_message` response property `oneOf` list for the response status `200` - removed `#/components/schemas/Sendbird.MessageResponse` from the `channels/items/last_message` response property `oneOf` list for the response status `200` - …earlier changes not shown [Operation history](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/changes/v3/group_channels/get.md) --- [API](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk.md) - [All operations](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/llms.txt) - [OpenAPI document](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/revisions/9e53a5288df0?raw)