Whitelists

List whitelists

get

List whitelists in the same workspace.

Authorizations

Query parameters

pageany ofOptional

Which page to fetch

Default: 1

notOptional

or

integer · min: 1Optional

pageSizeany ofOptional

Page size to use

Default: 30

notOptional

or

integer · min: 1 · max: 30Optional

statusstring · enumOptional

Whitelist status

Possible values:

sortBystring · enumOptional

Sort by attribute

Default: createdAtPossible values:

sortOrderstring · enumOptional

Sort order

Default: ascPossible values:

Responses

200

Successful response

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

GET /rest/whitelists HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "id": "text",
      "legacyId": 1,
      "name": "text",
      "status": "ACTIVE",
      "addresses": [
        {
          "name": "text",
          "currency": "text",
          "address": "text",
          "destinationTags": [
            "text"
          ]
        }
      ],
      "createdAt": "2025-05-30T23:37:27.790Z",
      "updatedAt": "2025-05-30T23:37:27.790Z",
      "description": "text"
    }
  ]
}

Get a single whitelist

get

Find a whitelist by ID.

Authorizations

Path parameters

idstringRequired

Id of the target group

Responses

200

Successful response

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

GET /rest/whitelists/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "legacyId": 1,
  "name": "text",
  "status": "ACTIVE",
  "addresses": [
    {
      "name": "text",
      "currency": "text",
      "address": "text",
      "destinationTags": [
        "text"
      ]
    }
  ],
  "createdAt": "2025-05-30T23:37:27.790Z",
  "updatedAt": "2025-05-30T23:37:27.790Z",
  "description": "text"
}