List channels
GET {{baseUrl}}/v3/group_channels
List channels
Retrieves a list of group channels in the application.
Note: If you want to get a list of a specific user's group channels, use the list my group channels action instead.
https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-list-channels
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
token | string | ||
limit | string | ||
distinct_mode | string | ||
public_mode | string | ||
super_mode | string | ||
created_after | string | ||
created_before | string | ||
show_empty | string | ||
show_member | string | ||
show_delivery_receipt | string | ||
show_read_receipt | string | ||
show_metadata | string | ||
show_frozen | string | ||
order | string | ||
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 | string | ||
custom_type | string | ||
read_receipt | string | ||
member | string | ||
is_distinct | string | ||
members_in | string | ||
user_id | string |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Api-Token | string | (Required) | |
Accept | string |
RESPONSES
status: OK
{"channels":[{"channel_url":"\u003cstring\u003e","cover_url":"\u003cstring\u003e","created_at":"\u003cnumber\u003e","created_by":{"require_auth_for_profile_image":"\u003cboolean\u003e","nickname":"\u003cstring\u003e","user_id":"\u003cstring\u003e","profile_url":"\u003cstring\u003e"},"creator":{"require_auth_for_profile_image":"\u003cboolean\u003e","is_online":"\u003cboolean\u003e","user_id":"\u003cstring\u003e","access_token":"\u003cstring\u003e","has_ever_logged_in":"\u003cboolean\u003e","is_active":"\u003cboolean\u003e","last_seen_at":"\u003cinteger\u003e","nickname":"\u003cstring\u003e","discovery_keys":["\u003cstring\u003e","\u003cstring\u003e"],"session_tokens":["\u003cstring\u003e","\u003cstring\u003e"],"preferred_languages":["\u003cstring\u003e","\u003cstring\u003e"],"profile_url":"\u003cstring\u003e","created_at":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e","local":"\u003cstring\u003e","locale":"\u003cstring\u003e","is_hide_me_from_friends":"\u003cboolean\u003e","is_shadow_blocked":"\u003cboolean\u003e","is_created":"\u003cboolean\u003e","metadata":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"description":"\u003cstring\u003e","end_at":"\u003cnumber\u003e","start_at":"\u003cnumber\u003e"},"custom_type":"\u003cstring\u003e","data":"\u003cstring\u003e","disappearing_message":{"message_survival_seconds":"\u003cnumber\u003e","is_triggered_by_message_read":"\u003cboolean\u003e"},"freeze":"\u003cboolean\u003e","ignore_profanity_filter":"\u003cboolean\u003e","hidden_state":"\u003cstring\u003e","invited_at":"\u003cnumber\u003e","inviter":{"require_auth_for_profile_image":"\u003cboolean\u003e","is_online":"\u003cboolean\u003e","user_id":"\u003cstring\u003e","access_token":"\u003cstring\u003e","has_ever_logged_in":"\u003cboolean\u003e","is_active":"\u003cboolean\u003e","last_seen_at":"\u003cinteger\u003e","nickname":"\u003cstring\u003e","discovery_keys":["\u003cstring\u003e","\u003cstring\u003e"],"session_tokens":["\u003cstring\u003e","\u003cstring\u003e"],"preferred_languages":["\u003cstring\u003e","\u003cstring\u003e"],"profile_url":"\u003cstring\u003e","created_at":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e","local":"\u003cstring\u003e","locale":"\u003cstring\u003e","is_hide_me_from_friends":"\u003cboolean\u003e","is_shadow_blocked":"\u003cboolean\u003e","is_created":"\u003cboolean\u003e","metadata":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"description":"\u003cstring\u003e","end_at":"\u003cnumber\u003e","start_at":"\u003cnumber\u003e"},"is_access_code_required":"\u003cboolean\u003e","is_broadcast":"\u003cboolean\u003e","is_created":"\u003cboolean\u003e","is_discoverable":"\u003cboolean\u003e","is_distinct":"\u003cboolean\u003e","is_ephemeral":"\u003cboolean\u003e","is_frozen":"\u003cboolean\u003e","is_hidden":"\u003cboolean\u003e","is_public":"\u003cboolean\u003e","is_push_enabled":"\u003cboolean\u003e","is_super":"\u003cboolean\u003e","joined_at":"\u003cnumber\u003e","joined_member_count":"\u003cnumber\u003e","last_message":{"require_auth":"\u003cboolean\u003e","message_survival_seconds":"\u003cnumber\u003e","custom_type":"\u003cstring\u003e","mentioned_users":[{"user_id":"\u003cstring\u003e","nickname":"\u003cstring\u003e","profile_url":"\u003cstring\u003e","metadata":{"anyOf":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},{"user_id":"\u003cstring\u003e","nickname":"\u003cstring\u003e","profile_url":"\u003cstring\u003e","metadata":{"anyOf":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}],"translations":"\u003cobject\u003e","updated_at":"\u003cnumber\u003e","is_op_msg":"\u003cboolean\u003e","is_removed":"\u003cboolean\u003e","user":{"require_auth_for_profile_image":"\u003cboolean\u003e","is_active":"\u003cboolean\u003e","role":"\u003cstring\u003e","user_id":"\u003cstring\u003e","nickname":"\u003cstring\u003e","profile_url":"\u003cstring\u003e","metadata":{"anyOf":"\u003cstring\u003e"}},"file":"\u003cobject\u003e","message":"\u003cstring\u003e","data":"\u003cstring\u003e","message_retention_hour":"\u003cnumber\u003e","silent":"\u003cboolean\u003e","type":"\u003cstring\u003e","created_at":"\u003cnumber\u003e","channel_type":"\u003cstring\u003e","req_id":"\u003cstring\u003e","mention_type":"\u003cstring\u003e","channel_url":"\u003cstring\u003e","message_id":"\u003cnumber\u003e","size":"\u003cnumber\u003e","sorted_metaarray":["\u003cobject\u003e","\u003cobject\u003e"],"thread_info":"\u003cobject\u003e","parent_message_id":"\u003cnumber\u003e","parent_message_info":"\u003cobject\u003e","is_reply_to_channel":"\u003cboolean\u003e"},"max_length_message":"\u003cnumber\u003e","member_count":"\u003cnumber\u003e","members":[{"connection_status":"\u003cstring\u003e","friend_discovery_key":"\u003cstring\u003e","friend_name":"\u003cstring\u003e","is_active":"\u003cboolean\u003e","is_blocked_by_me":"\u003cboolean\u003e","is_blocking_me":"\u003cboolean\u003e","is_muted":"\u003cboolean\u003e","last_seen_at":"\u003cinteger\u003e","meta_data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nickname":"\u003cstring\u003e","plain_profile_url":"\u003cstring\u003e","preferred_languages":["\u003cstring\u003e","\u003cstring\u003e"],"profile_url":"\u003cstring\u003e","require_auth":"\u003cboolean\u003e","restriction_info":{"description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"end_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"restriction_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"role":"\u003cstring\u003e","state":"\u003cstring\u003e","user_id":"\u003cstring\u003e"},{"connection_status":"\u003cstring\u003e","friend_discovery_key":"\u003cstring\u003e","friend_name":"\u003cstring\u003e","is_active":"\u003cboolean\u003e","is_blocked_by_me":"\u003cboolean\u003e","is_blocking_me":"\u003cboolean\u003e","is_muted":"\u003cboolean\u003e","last_seen_at":"\u003cinteger\u003e","meta_data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nickname":"\u003cstring\u003e","plain_profile_url":"\u003cstring\u003e","preferred_languages":["\u003cstring\u003e","\u003cstring\u003e"],"profile_url":"\u003cstring\u003e","require_auth":"\u003cboolean\u003e","restriction_info":{"description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"end_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"restriction_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"role":"\u003cstring\u003e","state":"\u003cstring\u003e","user_id":"\u003cstring\u003e"}],"message_offset_timestamp":"\u003cnumber\u003e","message_survival_seconds":"\u003cnumber\u003e","my_count_preference":"\u003cstring\u003e","my_last_read":"\u003cnumber\u003e","my_member_state":"\u003cstring\u003e","my_muted_state":"\u003cstring\u003e","my_push_trigger_option":"\u003cstring\u003e","my_role":"\u003cstring\u003e","name":"\u003cstring\u003e","operators":["\u003cstring\u003e","\u003cstring\u003e"],"sms_fallback":{"wait_seconds":"\u003cnumber\u003e","exclude_user_ids":["\u003cstring\u003e","\u003cstring\u003e"]},"unread_mention_count":"\u003cnumber\u003e","unread_message_count":"\u003cnumber\u003e"},{"channel_url":"\u003cstring\u003e","cover_url":"\u003cstring\u003e","created_at":"\u003cnumber\u003e","created_by":{"require_auth_for_profile_image":"\u003cboolean\u003e","nickname":"\u003cstring\u003e","user_id":"\u003cstring\u003e","profile_url":"\u003cstring\u003e"},"creator":{"require_auth_for_profile_image":"\u003cboolean\u003e","is_online":"\u003cboolean\u003e","user_id":"\u003cstring\u003e","access_token":"\u003cstring\u003e","has_ever_logged_in":"\u003cboolean\u003e","is_active":"\u003cboolean\u003e","last_seen_at":"\u003cinteger\u003e","nickname":"\u003cstring\u003e","discovery_keys":["\u003cstring\u003e","\u003cstring\u003e"],"session_tokens":["\u003cstring\u003e","\u003cstring\u003e"],"preferred_languages":["\u003cstring\u003e","\u003cstring\u003e"],"profile_url":"\u003cstring\u003e","created_at":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e","local":"\u003cstring\u003e","locale":"\u003cstring\u003e","is_hide_me_from_friends":"\u003cboolean\u003e","is_shadow_blocked":"\u003cboolean\u003e","is_created":"\u003cboolean\u003e","metadata":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"description":"\u003cstring\u003e","end_at":"\u003cnumber\u003e","start_at":"\u003cnumber\u003e"},"custom_type":"\u003cstring\u003e","data":"\u003cstring\u003e","disappearing_message":{"message_survival_seconds":"\u003cnumber\u003e","is_triggered_by_message_read":"\u003cboolean\u003e"},"freeze":"\u003cboolean\u003e","ignore_profanity_filter":"\u003cboolean\u003e","hidden_state":"\u003cstring\u003e","invited_at":"\u003cnumber\u003e","inviter":{"require_auth_for_profile_image":"\u003cboolean\u003e","is_online":"\u003cboolean\u003e","user_id":"\u003cstring\u003e","access_token":"\u003cstring\u003e","has_ever_logged_in":"\u003cboolean\u003e","is_active":"\u003cboolean\u003e","last_seen_at":"\u003cinteger\u003e","nickname":"\u003cstring\u003e","discovery_keys":["\u003cstring\u003e","\u003cstring\u003e"],"session_tokens":["\u003cstring\u003e","\u003cstring\u003e"],"preferred_languages":["\u003cstring\u003e","\u003cstring\u003e"],"profile_url":"\u003cstring\u003e","created_at":"\u003cinteger\u003e","phone_number":"\u003cstring\u003e","local":"\u003cstring\u003e","locale":"\u003cstring\u003e","is_hide_me_from_friends":"\u003cboolean\u003e","is_shadow_blocked":"\u003cboolean\u003e","is_created":"\u003cboolean\u003e","metadata":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"description":"\u003cstring\u003e","end_at":"\u003cnumber\u003e","start_at":"\u003cnumber\u003e"},"is_access_code_required":"\u003cboolean\u003e","is_broadcast":"\u003cboolean\u003e","is_created":"\u003cboolean\u003e","is_discoverable":"\u003cboolean\u003e","is_distinct":"\u003cboolean\u003e","is_ephemeral":"\u003cboolean\u003e","is_frozen":"\u003cboolean\u003e","is_hidden":"\u003cboolean\u003e","is_public":"\u003cboolean\u003e","is_push_enabled":"\u003cboolean\u003e","is_super":"\u003cboolean\u003e","joined_at":"\u003cnumber\u003e","joined_member_count":"\u003cnumber\u003e","last_message":{"require_auth":"\u003cboolean\u003e","message_survival_seconds":"\u003cnumber\u003e","custom_type":"\u003cstring\u003e","mentioned_users":[{"user_id":"\u003cstring\u003e","nickname":"\u003cstring\u003e","profile_url":"\u003cstring\u003e","metadata":{"anyOf":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},{"user_id":"\u003cstring\u003e","nickname":"\u003cstring\u003e","profile_url":"\u003cstring\u003e","metadata":{"anyOf":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}],"translations":"\u003cobject\u003e","updated_at":"\u003cnumber\u003e","is_op_msg":"\u003cboolean\u003e","is_removed":"\u003cboolean\u003e","user":{"require_auth_for_profile_image":"\u003cboolean\u003e","is_active":"\u003cboolean\u003e","role":"\u003cstring\u003e","user_id":"\u003cstring\u003e","nickname":"\u003cstring\u003e","profile_url":"\u003cstring\u003e","metadata":{"anyOf":"\u003cstring\u003e"}},"file":"\u003cobject\u003e","message":"\u003cstring\u003e","data":"\u003cstring\u003e","message_retention_hour":"\u003cnumber\u003e","silent":"\u003cboolean\u003e","type":"\u003cstring\u003e","created_at":"\u003cnumber\u003e","channel_type":"\u003cstring\u003e","req_id":"\u003cstring\u003e","mention_type":"\u003cstring\u003e","channel_url":"\u003cstring\u003e","message_id":"\u003cnumber\u003e","size":"\u003cnumber\u003e","sorted_metaarray":["\u003cobject\u003e","\u003cobject\u003e"],"thread_info":"\u003cobject\u003e","parent_message_id":"\u003cnumber\u003e","parent_message_info":"\u003cobject\u003e","is_reply_to_channel":"\u003cboolean\u003e"},"max_length_message":"\u003cnumber\u003e","member_count":"\u003cnumber\u003e","members":[{"connection_status":"\u003cstring\u003e","friend_discovery_key":"\u003cstring\u003e","friend_name":"\u003cstring\u003e","is_active":"\u003cboolean\u003e","is_blocked_by_me":"\u003cboolean\u003e","is_blocking_me":"\u003cboolean\u003e","is_muted":"\u003cboolean\u003e","last_seen_at":"\u003cinteger\u003e","meta_data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nickname":"\u003cstring\u003e","plain_profile_url":"\u003cstring\u003e","preferred_languages":["\u003cstring\u003e","\u003cstring\u003e"],"profile_url":"\u003cstring\u003e","require_auth":"\u003cboolean\u003e","restriction_info":{"description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"end_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"restriction_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"role":"\u003cstring\u003e","state":"\u003cstring\u003e","user_id":"\u003cstring\u003e"},{"connection_status":"\u003cstring\u003e","friend_discovery_key":"\u003cstring\u003e","friend_name":"\u003cstring\u003e","is_active":"\u003cboolean\u003e","is_blocked_by_me":"\u003cboolean\u003e","is_blocking_me":"\u003cboolean\u003e","is_muted":"\u003cboolean\u003e","last_seen_at":"\u003cinteger\u003e","meta_data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nickname":"\u003cstring\u003e","plain_profile_url":"\u003cstring\u003e","preferred_languages":["\u003cstring\u003e","\u003cstring\u003e"],"profile_url":"\u003cstring\u003e","require_auth":"\u003cboolean\u003e","restriction_info":{"description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"end_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"restriction_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"role":"\u003cstring\u003e","state":"\u003cstring\u003e","user_id":"\u003cstring\u003e"}],"message_offset_timestamp":"\u003cnumber\u003e","message_survival_seconds":"\u003cnumber\u003e","my_count_preference":"\u003cstring\u003e","my_last_read":"\u003cnumber\u003e","my_member_state":"\u003cstring\u003e","my_muted_state":"\u003cstring\u003e","my_push_trigger_option":"\u003cstring\u003e","my_role":"\u003cstring\u003e","name":"\u003cstring\u003e","operators":["\u003cstring\u003e","\u003cstring\u003e"],"sms_fallback":{"wait_seconds":"\u003cnumber\u003e","exclude_user_ids":["\u003cstring\u003e","\u003cstring\u003e"]},"unread_mention_count":"\u003cnumber\u003e","unread_message_count":"\u003cnumber\u003e"}],"next":"\u003cstring\u003e","ts":"\u003cnumber\u003e"}