SEsendbird
Moderation

List blocked users

Changed on

List blocked by and blocking users

This action retrieves a list of users who are either blocked by a specific user or a list of users who are blocking a specific user.

https://sendbird.com/docs/chat/platform-api/v3/moderation/listing-blocked-and-blocking-users/list-blocked-and-blocking-users#1-list-blocked-by-and-blocking-users

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

get/v3/users/{user_id}/block

Request

  • Base URL
    https://api-APP_ID.sendbird.com
  • Auth
    none declared

Path parameters

user_idstring required

(Required)

Query parameters

list'blocked_by_me' | 'blocking_me'

Specifies whether to retrieve a list of users who are blocked by the specified user or a list of users who are blocking the specified user. Acceptable values are blocked_by_me and blocking_me. The me in the values refers to the user specified in the parameter. (Default: blocked_by_me)

tokenstring
limitinteger
user_idsstring

Specifies the user IDs of the blocked or blocking users to search for. The value should be a comma-separated string that consists of multiple URL encoded user IDs.

metadatakeystring
metadatavalues_instring

Headers

api-tokenstring
Example:{{API_TOKEN}}

Response

Successful response

nextstring

Example response

{
  "next": "next",
  "users": [
    {
      "metadata": "{}",
      "is_active": true,
      "preferred_languages": [
        "preferred_languages",
        "preferred_languages"
      ],
      "require_auth_for_profile_image": true,
      "unread_channel_count": 6,
      "discovery_keys": [
        "discovery_keys",
        "discovery_keys"
      ],
      "profile_url": "profile_url",
      "is_created": true,
      "created_at": 9,
      "has_ever_logged_in": true,
      "locale": "locale",
      "unread_message_count": 8,
      "access_token": "access_token",
      "is_shadow_blocked": true,
      "user_id": "user_id",
      "nickname": "nickname",
      "phone_number": "phone_number",
      "is_online": true,
      "state": "",
      "is_hide_me_from_friends": true,
      "last_seen_at": 9
    },
    {
      "metadata": "{}",
      "is_active": true,
      "preferred_languages": [
        "preferred_languages",
        "preferred_languages"
      ],
      "require_auth_for_profile_image": true,
      "unread_channel_count": 6,
      "discovery_keys": [
        "discovery_keys",
        "discovery_keys"
      ],
      "profile_url": "profile_url",
      "is_created": true,
      "created_at": 9,
      "has_ever_logged_in": true,
      "locale": "locale",
      "unread_message_count": 8,
      "access_token": "access_token",
      "is_shadow_blocked": true,
      "user_id": "user_id",
      "nickname": "nickname",
      "phone_number": "phone_number",
      "is_online": true,
      "state": "",
      "is_hide_me_from_friends": true,
      "last_seen_at": 9
    }
  ]
}

Changes

  • b05d4e3c6329Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • warning

      removed the optional property // from the response with the status

    • info

      the response's property default value was added for the status

  • 7a85bad03e90Revision changes
    • breaking

      the /// response's property type changed from object to string for status

    • warning

      deleted the header request parameter Api-Token

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional header request parameter api-token

    • info

      added the new optional query request parameter list

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response property // became required for the status