---
title: "List accounts"
method: GET
path: "/accounts"
tags: ["account"]
---

# List accounts

`GET /accounts`

## Query parameters

- `page` integer — Which page to fetch
- `pageSize` integer — Page size to use
- `status` 'ACTIVE' | 'INACTIVE' — Account status
- `name` string — Search by matching name
- `governanceType` 'CLASSIC' | 'TRADELINK' | 'RAW_SIGNING' — Account governance type
- `allowedAction` 'SEND' | 'DEPLOY_CONTRACT' | 'EXECUTE_CONTRACT' | 'ACTIVATE_TOKEN' | 'RECEIVE' | 'STAKE' | 'SIGN_MESSAGE' | 'SIGN_DIGESTS' — Filter accounts by allowed action for current user
- `sortBy` 'name' | 'currency' | 'index' | 'createdAt' | 'updatedAt' — Sort by attribute
- `sortOrder` 'asc' | 'desc' — Sort order
- `currency` union — Deprecated: use `assets` instead. Filter accounts by currencies
  - string
  - string[]
- `index` number — Filter accounts by account index
- `contractAddress` string — Deprecated: use `assets` instead. Filter accounts by token contract address
- `support` 'standalone' | 'legacy' — Filter accounts by support
- `type` 'BITCOIN_LIKE' | 'CANTON_LIKE' | 'CARDANO_LIKE' | 'ETHEREUM_LIKE' | 'GENERIC_LIKE' | 'HEDERA_LIKE' | 'POLKADOT_LIKE' | 'RAW_SIGNING' | 'RIPPLE_LIKE' | 'SOLANA_LIKE' | 'STELLAR_LIKE' | 'SUI_LIKE' | 'TEZOS_LIKE' | 'TRON_LIKE' — Filter accounts by type
- `policyIds` string[] — Filter accounts by policies
- `entityIds` string[] — Filter accounts by entities
- `portfolioIds` string[] — Filter accounts by portfolios
- `userIds` string[] — Filter accounts involving these users (direct or via group membership). ORed with groupIds.
- `groupIds` string[] — Filter accounts involving these groups. ORed with userIds.
- `assets` object[]
  - `network` string, required — Filter accounts by network
  - `contractAddress` string — Filter accounts by token contract address

## 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` object[], required — Array of results
    - `id` string, required — Internal unique identifier
    - `legacyId` number, required — Legacy internal unique identifier (for retro-compatibility)
    - `name` string, required — Name
    - `currency` string, required — Will be deprecated soon, use network instead. Currency
    - `network` string, required — Network (Same as currency for now)
    - `contractAddress` string, required — Token contract address for Token account
    - `tokenIdentifier` string, required — Token identifier for Token account
    - `index` number, required — BIP44 account index
    - `derivationPath` string, required — Derivation path
    - `status` 'ACTIVE' | 'INACTIVE', required — Status
    - `createdAt` string, required — Creation timestamp
    - `updatedAt` string, required — Last modification timestamp
    - `asset` union, required — Account asset fields
      - object — Raw signing account
        - `type` string, required — Account type
      - object — Bitcoin-like
        - `type` string, required — Account type
        - `xpub` string, required — xpub (extended public key)
        - `addressDerivationMode` 'NEW' | 'STATIC', required — Bitcoin address derivation mode
      - object — Canton-like
        - `type` string, required — Account type
        - `address` string, required — Account address
      - object — Cardano-like
        - `type` string, required — Account type
        - `address` string, required — Account address
      - object — Ethereum-like
        - `type` string, required — Account type
        - `address` string, required — Account address
      - object — Generic-like
        - `type` string, required — Account type
      - object — Hedera-like
        - `type` string, required — Account type
        - `address` string, required — Account address
        - `isActivated` boolean, required — Indicates if the account is activated
      - object — Polkadot-like
        - `type` string, required — Account type
        - `address` string, required — Account address
      - object — Ripple-like
        - `type` string, required — Account type
        - `address` string, required — Account address
      - object — Solana-like
        - `type` string, required — Account type
        - `address` string, required — Account address
      - object — Stellar-like
        - `type` string, required — Account type
        - `address` string, required — Account address
      - object — Sui-like
        - `type` string, required — Account type
        - `address` string, required — Account address
      - object — Tezos-like
        - `type` string, required — Account type
        - `address` string, required — Account address
      - object — Tron-like
        - `type` string, required — Account type
        - `address` string, required — Account address
    - `governance` union, required — Governance fields
      - object — Classic
        - `type` string, required — Classic account governance
        - `policyId` string, required — Identifier of corresponding governance policy
      - object — Raw Signing
        - `type` string, required — Raw signing account governance
        - `policyId` string, required — Identifier of corresponding governance policy
      - object — Tradelink
        - `type` string, required — Tradelink account governance
        - `assetManagerId` string, required — Identifier of corresponding asset manager
        - `exchangeConfigs` object[], required — Tradelink exchange configurations
          - `exchangeId` string, required — Tradelink exchange id
          - `repledgeAuthorized` boolean, required — Determines whether this exchange is authorized to repledge on this account
          - `needsAssetManagerApprovalForSettlements` boolean, required — Determines whether asset manager will "pre-approve" the settlement requests on this account

## 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)