---
title: "List whitelists"
method: GET
path: "/whitelists"
tags: ["whitelist"]
---

# List whitelists

`GET /whitelists`

List whitelists in the same workspace.

## Query parameters

- `page` integer — Which page to fetch
- `pageSize` integer — Page size to use
- `status` 'ACTIVE' | 'INACTIVE' — Whitelist status
- `sortBy` 'name' | 'status' | 'createdAt' | 'updatedAt' — Sort by attribute
- `sortOrder` 'asc' | 'desc' — Sort order

## Response `200`

Successful response

- object
  - `page` number, required — Current page
  - `next` number, required — Next page or null if there is none
  - `prev` number, required — Previous page or null if there is none
  - `pageSize` number, required — Max count of items per page
  - `total` number, required — Total count of items
  - `results` WhitelistResponse[], required — Array of results
    - `id` string, required — Internal unique identifier
    - `legacyId` number, required — Legacy internal unique identifier (for retro-compatibility)
    - `name` string, required — Whitelist name
    - `type` 'TRANSACTION' | 'SMART_CONTRACT', required — Whitelist usage type
    - `status` 'ACTIVE' | 'INACTIVE', required — Whitelist status
    - `addresses` object[], required
      - `name` string, required — Address name
      - `currency` string, required — Address currency
      - `address` string, required — Address value
      - `destinationTag` string — Destination tag (applicable for Ripple currency)
    - `createdAt` string, required — Creation timestamp
    - `updatedAt` string, required — Last modification timestamp
    - `description` string, required — Whitelist description

## Other responses

- `400` — Invalid input data
- `401` — Authorization not provided
- `403` — Insufficient access
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/ledgerhq/apis/vault-api.md) · [All operations](https://skmtc.net/ledgerhq/apis/vault-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ledgerhq/vault-api/revisions/c88faa17bc25/schema)