List members
Changed onList members
Retrieves a list of members of a group channel.
Note: See this page to learn more about channel types.
channel_url
Type: string
Description: Specifies the URL of the channel to retrieve a list of members of.
Request
- Base URLhttps://api-APP_ID.sendbird.com
- Authnone declared
Path parameters
(Required)
Query parameters
Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
Specifies the unique ID of a user. If user_id is provided, the response will include two additional boolean properties about each user in the members list.
- is_blocking_me: Indicates whether the listed user is blocking the user specified in the user_id parameter.
- is_blocked_by_me: Indicates whether the listed user is blocked by the user specified in the user_id parameter.
Specifies the method to sort a list of results. Acceptable values are the following:
- member_nickname_alphabetical (default): sorts by the member nicknames in alphabetical order.
- operator_then_member_alphabetical: sorts by the operational role and member nickname in alphabetical order where channel operators are listed before channel members.
Restricts the search scope to only retrieve operators or non-operator members of the channel. Acceptable values are the following:
- all (default): no filter is applied to the list.
- operator: only channel operators are retrieved.
- nonoperator: all channel members, except channel operators, are retrieved.
Restricts the search scope to retrieve members based on if they have accepted an invitation or if they were invited by a friend. Acceptable values are invited_only, joined_only, invited_by_friend, invited_by_non_friend, and all. (Default: all)
Restricts the search scope to retrieve members who are muted or unmuted in the channel. Acceptable values are all, muted, and unmuted. (Default: all)
Restricts the search scope to retrieve members who are activated or deactivated in the channel. Acceptable values are all, activated, and deactivated. (default: activated)
Searches for members whose nicknames start with the specified value. Urlencoding the value is recommended.
Determines whether to include information about the push preference of each member, such as push_enabled, push_trigger_option, and do_not_disturb. (Default: false)
Headers
Response
Successful response
Example response
{
"next": "next",
"members": [
{
"metadata": "{}",
"is_active": true,
"is_blocking_me": true,
"require_auth_for_profile_image": true,
"role": "",
"profile_url": "profile_url",
"muted_end_at": 2,
"delivered_ts": 9,
"do_not_disturb": true,
"is_muted": true,
"read_ts": 4,
"is_blocked_by_me": true,
"friend_name": "friend_name",
"friend_discovery_key": [
"friend_discovery_key",
"friend_discovery_key"
],
"muted_description": "muted_description",
"push_enabled": true,
"user_id": "user_id",
"nickname": "nickname",
"is_online": true,
"push_trigger_option": null,
"state": "",
"last_seen_at": 3
},
{
"metadata": "{}",
"is_active": true,
"is_blocking_me": true,
"require_auth_for_profile_image": true,
"role": "",
"profile_url": "profile_url",
"muted_end_at": 2,
"delivered_ts": 9,
"do_not_disturb": true,
"is_muted": true,
"read_ts": 4,
"is_blocked_by_me": true,
"friend_name": "friend_name",
"friend_discovery_key": [
"friend_discovery_key",
"friend_discovery_key"
],
"muted_description": "muted_description",
"push_enabled": true,
"user_id": "user_id",
"nickname": "nickname",
"is_online": true,
"push_trigger_option": null,
"state": "",
"last_seen_at": 3
}
]
}Changes
- breaking
the response property
//became nullable for the status - breaking
the response property
//became nullable for the status - info
the
response's property default valuewas added for the status
- breaking
- info
removed the
defaultenum value from the//response property for the response status
- info