List banned users
GET {{baseUrl}}/v3/group_channels/:channel_url/ban
List banned users
Retrieves a list of the banned users from a group channel.
https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-list-banned-users
channel_url
Type: string
Description: Specifies the URL of the channel where to retrieve a list of banned users.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
token | string | ||
limit | string |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Api-Token | string | (Required) | |
Accept | string |
RESPONSES
status: OK
{"banned_list":[{"user":{"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":{"constructor":{"arguments":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"caller":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"length":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"prototype":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"description":"\u003cstring\u003e","end_at":"\u003cnumber\u003e","start_at":"\u003cnumber\u003e"},"start_at":"\u003cnumber\u003e","end_at":"\u003cnumber\u003e","description":"\u003cstring\u003e"},{"user":{"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":{"constructor":{"arguments":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"caller":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"length":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"prototype":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"description":"\u003cstring\u003e","end_at":"\u003cnumber\u003e","start_at":"\u003cnumber\u003e"},"start_at":"\u003cnumber\u003e","end_at":"\u003cnumber\u003e","description":"\u003cstring\u003e"}],"total_ban_count":"\u003cnumber\u003e","next":"\u003cstring\u003e"}