SendbirdSendbird Chat Platform server-side API v3
GET/v3/group_channels
List group channels
Retrieves a list of group channels in the application; various query parameters let you narrow the search scope and choose which channel information to return. To list channels a specific user has joined, use the list-group-channels-by-user action under the User section instead.
Manage users, group channels, open channels, messages, metadata, moderation, bots, and announcements through the official Sendbird Chat Platform API v3. The complete boundary is the 83 REST endpoints reconstructed from a pinned official generated SDK revision; client realtime protocols and Chat SDKs are not part of this collection. Application data is the caller's private content, so Pontx does not proxy, cache, or aggregate it and callers use the local SDK/CLI directly.
Request
- operationId
listChannels- Server
https://api-{app_id}.sendbird.com- Authentication
- apiTokenAuth
Request parameters
token
querystring
Token.
next_page_token_abc
limit
querynumber
Result limit.
1
distinct_mode
querystring
Distinct channel mode.
all
public_mode
querystring
Public channel mode.
all
super_mode
querystring
Super channel mode.
all
created_after
querynumber
created after field.
1
created_before
querynumber
created before field.
1
show_empty
queryboolean
show empty field.
true
show_member
queryboolean
Whether to show members.
true
show_delivery_receipt
queryboolean
show delivery receipt field.
true
show_read_receipt
queryboolean
show read receipt field.
true
show_metadata
queryboolean
show metadata field.
true
show_frozen
queryboolean
show frozen field.
true
order
querystring
Sort order.
chronological
metadata_order_key
querystring
metadata order key field.
metadata_key
custom_types
querystring
custom types field.
custom_types_value
custom_type_startswith
querystring
custom type startswith field.
search_term
channel_urls
querystring
channel urls field.
channel_urls_value
name
querystring
Name.
Example Channel
name_contains
querystring
name contains field.
search_term
name_startswith
querystring
name startswith field.
search_term
members_exactly_in
querystring
members exactly in field.
members_exactly_in_value
members_include_in
querystring
members include in field.
members_include_in_value
query_type
querystring
query type field.
default
members_nickname
querystring
members nickname field.
Alice
members_nickname_contains
querystring
members nickname contains field.
Alice
metadata_key
querystring
metadata key field.
metadata_key
metadata_values
querystring
metadata values field.
metadata_value
metadata_value_startswith
querystring
metadata value startswith field.
metadata_value
metacounter_key
querystring
metacounter key field.
metadata_key
metacounter_values
querystring
metacounter values field.
metadata_value
metacounter_value_gt
querystring
metacounter value gt field.
metadata_value
metacounter_value_gte
querystring
metacounter value gte field.
metadata_value
metacounter_value_lt
querystring
metacounter value lt field.
metadata_value
metacounter_value_lte
querystring
metacounter value lte field.
metadata_value
include_sorted_metaarray_in_last_message
queryboolean
include sorted metaarray in last message field.
true
Responses
200
GroupChatListChannelsResponseapplication/json
Request succeeded.
Properties: channelsnextts
400
SendbirdApiErrorapplication/json
Request parameters are invalid.
Properties: codemessage
401
SendbirdApiErrorapplication/json
Unauthenticated or the API token is invalid.
Properties: codemessage
403
SendbirdApiErrorapplication/json
Access to the resource is forbidden.
Properties: codemessage
404
SendbirdApiErrorapplication/json
The requested resource was not found.
Properties: codemessage
429
SendbirdApiErrorapplication/json
Rate limited; retry later.
Properties: codemessage
500
SendbirdApiErrorapplication/json
Upstream internal error.
Properties: codemessage
{
"channels": [],
"next": "next_page_token_abc",
"ts": 1
}