Query soft-deleted users

Retrieve the list of soft-deleted user IDs.

tip

The returned list may include users whose soft deletion is still in progress. To receive deletion completion results, use the User soft deletion/restoration status callback.

Request method

POST: https://Base URL/v4/user/soft-deleted/list

Signature required: All server API requests require signature verification. See API request signature.

Rate limit: 100 requests per second

Request body

The request body is in application/json format and supports the following parameters:

Parameter	Type	Required	Description
page	Number	No	Page number. Starts at 1. Defaults to 1.
pageSize	Number	No	Items per page. Maximum 50. Defaults to 50.

Request example

HTTP

POST /v4/user/soft-deleted/list HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
  "page": 1,
  "pageSize": 50
}

Response

Field	Type	Description
code	Number	Status code. 0 indicates success.
result.userIds	String[]	List of soft-deleted user IDs.

Response example

HTTP

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":0,"result":{"userIds":["uid1","uid2"]}}