List banned channels

GET {{baseUrl}}/v3/users/:user_id/ban

List banned channels

Retrieves a list of open and group channels with additional information where a user is banned.

https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-banned-channels

user_id Type: string Description: Specifies the unique ID of the target user.

Request Params

KeyDatatypeRequiredDescription
tokenstring
limitstring

HEADERS

KeyDatatypeRequiredDescription
Api-Tokenstring(Required)
Acceptstring

RESPONSES

status: OK

{"banned_channels":[{"start_at":"\u003cnumber\u003e","description":"\u003cstring\u003e","channel":{"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":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_online":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"access_token":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"has_ever_logged_in":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_active":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"last_seen_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nickname":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"discovery_keys":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"session_tokens":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"preferred_languages":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"profile_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"local":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"locale":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_hide_me_from_friends":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_shadow_blocked":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_created":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"metadata":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"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"},"start_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\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":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_online":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"access_token":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"has_ever_logged_in":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_active":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"last_seen_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nickname":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"discovery_keys":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"session_tokens":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"preferred_languages":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"profile_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"local":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"locale":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_hide_me_from_friends":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_shadow_blocked":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_created":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"metadata":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"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"},"start_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\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":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"message_survival_seconds":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"custom_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"mentioned_users":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"translations":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_op_msg":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_removed":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"file":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"message":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"message_retention_hour":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"silent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"channel_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"req_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"mention_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"channel_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"message_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"size":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sorted_metaarray":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"thread_info":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"parent_message_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"parent_message_info":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_reply_to_channel":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"max_length_message":"\u003cnumber\u003e","member_count":"\u003cnumber\u003e","members":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\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":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"unread_mention_count":"\u003cnumber\u003e","unread_message_count":"\u003cnumber\u003e"},"end_at":"\u003cnumber\u003e"},{"start_at":"\u003cnumber\u003e","description":"\u003cstring\u003e","channel":{"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":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_online":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"access_token":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"has_ever_logged_in":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_active":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"last_seen_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nickname":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"discovery_keys":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"session_tokens":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"preferred_languages":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"profile_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"local":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"locale":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_hide_me_from_friends":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_shadow_blocked":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_created":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"metadata":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"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"},"start_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\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":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_online":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"access_token":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"has_ever_logged_in":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_active":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"last_seen_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nickname":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"discovery_keys":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"session_tokens":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"preferred_languages":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"profile_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"local":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"locale":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_hide_me_from_friends":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_shadow_blocked":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_created":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"metadata":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"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"},"start_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\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":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"message_survival_seconds":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"custom_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"mentioned_users":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"translations":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_op_msg":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_removed":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"file":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"message":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"message_retention_hour":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"silent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"channel_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"req_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"mention_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"channel_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"message_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"size":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sorted_metaarray":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"thread_info":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"parent_message_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"parent_message_info":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"is_reply_to_channel":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"max_length_message":"\u003cnumber\u003e","member_count":"\u003cnumber\u003e","members":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\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":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"unread_mention_count":"\u003cnumber\u003e","unread_message_count":"\u003cnumber\u003e"},"end_at":"\u003cnumber\u003e"}],"next":"\u003cstring\u003e"}