Sendbird/listMembers

Online calls unavailable · details below

SendbirdSendbird Chat Platform server-side API v3

GET/v3/group_channels/{channel_url}/members

List group channel members

Retrieves the member list of the group channel identified by channel_url, with query parameters to filter and paginate the member information.

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
listMembers
Server
https://api-{app_id}.sendbird.com
Authentication
apiTokenAuth

Request parameters

channel_url

pathstringrequired

Channel URL.

group_channel_123

token

querystring

Token.

next_page_token_abc

limit

querynumber

Result limit.

1

user_id

querystring

User identifier.

user_id_123

show_delivery_receipt

queryboolean

show delivery receipt field.

true

show_read_receipt

queryboolean

show read receipt field.

true

show_member_is_muted

queryboolean

show member is muted field.

true

order

querystring

Sort order.

member_nickname_alphabetical

operator_filter

querystring

operator filter field.

all

member_state_filter

querystring

Member state filter.

all

muted_member_filter

querystring

muted member filter field.

all

member_active_mode_filter

querystring

member active mode filter field.

activated

nickname_startswith

querystring

nickname startswith field.

Alice

include_push_preference

queryboolean

include push preference field.

true

Responses

200

GroupChannelListMembersResponseapplication/json

Request succeeded.

Properties: membersnext

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

{
  "members": [],
  "next": "next_page_token_abc"
}