Retrieve Blacklists

GET /api/blacklist

List all Blacklist records

cURL

curl --request GET \
  --url http://localhost/api/api/blacklist \
  --header 'Authorization: Bearer <token>'

200

{
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "list_name": "<string>",
      "reference_id": "<string>",
      "created_by": 123,
      "modified_by": 123
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

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

CustomAuthenticationcookieAuth

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

Show child attributes

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"