Whitelists
List whitelists in the same workspace.
Authorizations
Query parameters
pageany ofOptionalDefault:
Which page to fetch
1
notOptional
integer · min: 1Optional
pageSizeany ofOptionalDefault:
Page size to use
30
notOptional
integer · min: 1 · max: 30Optional
statusstring · enumOptionalPossible values:
Whitelist status
sortBystring · enumOptionalDefault:
Sort by attribute
createdAt
Possible values: sortOrderstring · enumOptionalDefault:
Sort order
asc
Possible values: Responses
200
Successful response
application/json
default
Error response
application/json
get
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-06-23T02:00:50.157Z",
"updatedAt": "2025-06-23T02:00:50.157Z",
"description": "text"
}
]
}
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
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-06-23T02:00:50.157Z",
"updatedAt": "2025-06-23T02:00:50.157Z",
"description": "text"
}