Skip to main content
GET
/
api
/
blacklist
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "reference_id": "<string>",
      "list_name": "<string>",
      "created_by": 123,
      "modified_by": 123
    }
  ]
}
Retrieve all Blacklist records If there are more than 10 records available, the records provided in the response will be paginated by 10 records per page.

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Query Parameters

​
limit
integer

Number of results to return per page.

​
name
string
​
offset
integer

The initial index from which to return the results.

​
reference_id
string

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"