Retrieves a list of users that a user has blocked.
The following table lists the parameters that this action supports.
Parameters
Required | Type | Description |
---|---|---|
user_id | string | Specifies the unique ID of the user. |
Optional | Type | Description |
---|---|---|
token | string | Specifies a page token that indicates the starting index of results to retrieve. If not specified, the index is set as 0. |
limit | int | Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10) |
user_ids | string | Specifies the user IDs of the blocked users to search for. The value should be a comma-separated string that consists of multiple urlencoded user IDs. An example of a urlencoded string is |
metadatakey | string | Specifies a keyword to search for. The keyword acts as a filter to search for blocked users with metadata containing the keyword as a key. This parameter should be specified in conjunction with the |
metadatavalues_in | string | Specifies a keyword to search for. The keyword acts as a filter to search for blocked users with metadata containing the keyword in its values. This parameter works in conjunction with the key specified by the |
If successful, this action returns a list of blocked user resources in the response body.
Property name | Type | Description |
---|---|---|
users[] | array of objects | An array of blocked user. |
next | string | The value that can be used in the |
In the case of an error, an error object is returned. A detailed list of error codes is available here.