Get Whitelist by ID

Get whitelist by id

get

This method returns the whitelist that matches the entered ID.

Authorizations

X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters

whitelist_idintegerRequired

The whitelist's ID.

Responses

200

Whitelist object

application/json

created_byintegerRequiredExample: 5

created_onstring · date-timeRequired

descriptionstringRequiredExample: our own accounts

idintegerRequired

last_requestinteger · nullableOptionalDefault: nullExample: 3

namestringRequiredExample: internal accounts

statusstring · enumRequiredExample: ACTIVEPossible values:

404

Whitelist not found

application/json

get/whitelists/{whitelist_id}

GET /whitelists/{whitelist_id} HTTP/1.1
X-Ledger-API-Key: YOUR_API_KEY
X-Ledger-API-User: YOUR_API_KEY
Accept: */*

{
  "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": "2026-01-01T00:00:00.000Z",
  "description": "our own accounts",
  "id": 1,
  "last_request": 3,
  "name": "internal accounts",
  "status": "ACTIVE"
}