Search Whitelist
Use the following parameters to search whitelists.
Authorizations
Query parameters
accountinteger[] | nullableOptionalDefault:
Returns the whitelists used in the specified account's governance rules.
null
addressstring | nullableOptionalDefault:
Filters the list by address.
null
created_afterstring · date-time | nullableOptionalDefault:
Returns objects created after the entered date.
null
Example: 2020-09-12T14:15:22Z
created_beforestring · date-time | nullableOptionalDefault:
Returns objects created before the entered date.
null
Example: 2020-12-13T16:17:28Z
descriptionstring | nullableOptionalDefault:
Returns objects that contain the entered description.
null
idinteger | nullableOptionalDefault:
Returns the object corresponding to the entered ID
null
namestring | nullableOptionalDefault:
Filters the list by whitelist name.
null
orderstring · enum | nullableOptionalDefault:
Orders the list of results
null
Example: desc
Possible values: order_bystring | nullableOptionalDefault:
criteria to order by
null
Example: name
pageinteger | nullableOptionalDefault:
Defines the page number to be fetched.
1
Example: 3
page_sizeinteger | nullableOptionalDefault:
Defines the number of elements displayed on a page. Must be a positive number with 0 and -1 return a maximum defined in the gate
20
Example: 40
Responses
200
Whitelist search results
application/json
400
Invalid search parameters
application/json
get
GET /whitelists HTTP/1.1
Host:
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*
{
"edges": [
{
"cursor": 0,
"node": {
"addresses": [
{
"address": "tb1qrdw2mrllkm4lfjgnxeqz0yzjg6835sfyualdhy",
"currency": "bitcoin_testnet",
"destination_tag": null,
"id": 3,
"name": "main account"
},
{
"address": "mmWpcbXNXoKMjc6Q3WjPSxj4JbpLhAFotF",
"currency": "bitcoin_testnet",
"destination_tag": null,
"id": 4,
"name": "second account"
}
],
"created_by": 5,
"created_on": "2025-06-22T14:02:18.108Z",
"description": "our own accounts",
"id": 1,
"last_request": 3,
"name": "internal accounts",
"status": "ACTIVE"
}
}
],
"page_info": {
"count": 1,
"has_next_page": false
}
}
Last updated