Query Blacklist
Queries the blacklists of specific users.
- Only users that have installed the app will appear in the result.
URI Fragment
/blacklist/{-list|,|userId}/@all
/blacklist/{-list|,|userId}/@all/{-list|,|personId}
Parameter Name |
Type |
Description |
|---|---|---|
userId |
String or Number |
Use "@me" for current user, or direct numeric user ID. |
persionId |
Number |
User IDs of the users that you want to check whether they are in userId's blacklist. See below example. |
Supported Signing Methods
Client Only Signing, 3-legged Authorization Signing
 | Please refer here for the details of authentication flow and here for how to sign request to generate the Authorization header. |
HTTP Method
GET
Request Header
The Authorization header is necessary for this call to succeed.
URL Query Parameters
Parameter Name |
Type |
Description |
Required |
|---|---|---|---|
fields |
Array |
Blacklist fields to retrieve. |
No |
format |
String |
Currently only "json" can be used. |
No |
count |
Number |
Integer from 1-1000. Default is 50. |
No |
sortBy |
String |
Currently only "targetId" can be used. |
No |
sortOrder |
String |
"ascending" or "descending" |
No |
startIndex |
Number |
An integer starting from 1. |
No |
Request Body
None.
Response Status Code
HTTP Status Code |
HTTP Status Message |
Meaning |
|---|---|---|
200 |
OK |
Data successfully acquired |
400 |
Bad Request |
Corrupt request data on the client side |
401 |
Unauthorized |
Authorization error |
403 |
Forbidden |
The resource exists, but access is not possible due to a reason other than an authorization error. |
404 |
Not Found |
The resource does not exist. |
500 |
Internal Server Error |
An error on the API server side |
503 |
Service Unavailable |
The API cannot be used temporarily |
Response Body
- A single or a collection of blacklist id-targetId pairs in JSON format.
- Content-Type: application/json; charset=utf-8
Parameter Name
Type
Description
id
UserId
A user who has added a targetId user to the blacklist.
targetId
UserId
A user who has been added to the blacklist by an id user.
Example Request & Response
Retrieving all users listed in a user's blacklist.
Retrieving users listed in blacklist for multiple users.
Check whether specific users are listed in a user's blacklist.