---
title: "List accounts"
method: GET
path: "/v1/domains/{domainId}/accounts"
tags: ["Accounts"]
---

# List accounts

`GET /v1/domains/{domainId}/accounts`

## Path parameters

- `domainId` string, uuid, required

## Query parameters

- `limit` integer
- `startingAfter` string, uuid
- `sortBy` 'id' | 'alias' | 'ledgerId' | 'lock' | 'metadata.createdAt' | 'metadata.lastModifiedAt'
- `sortOrder` 'ASC' | 'DESC'
- `ledgerId` string
- `alias` string
- `providerDetails.vaultId` string, uuid
- `metadata.createdBy` string, uuid
- `metadata.lastModifiedBy` string, uuid
- `metadata.description` string
- `metadata.customProperties` string[]
- `lock` CoreLockStatus[]
- `additionalDetails.processingStatus` 'Pending' | 'Preparing' | 'Tracked' | 'Recovering' | 'Completed' | 'Interrupted'
- `additionalDetails.ledgers.ledgerId` string[]
- `additionalDetails.ledgers.status` CoreAccountLedgerStatus[]

## Response `200`

- CoreAccountsCollection
  - `items` CoreApiAccount[], required
    - `data` CoreAccount, required
      - `id` string, uuid, required
      - `domainId` string, uuid, required
      - `alias` string, required
      - `ledgerId` string
      - `providerDetails` CoreAccountProviderInformation, required
        - `vaultId` string, uuid, required
        - `keyStrategy` 'VaultHard' | 'VaultSoft' | 'Random', required
        - `keyInformation` union, required
          - CoreVaultAccountKeyInformationRandom
            - `publicKey` union
              - …
            - `type` 'Random', required
          - CoreVaultAccountKeyInformationVaultDerived
            - `publicKey` union
              - …
            - `derivationPath` string, required
            - `type` 'VaultDerived', required
        - `keys` CoreVaultAccountProviderInformationKey[]
          - union
            - CoreVaultAccountProviderInformationKeyVaultDerived
              - …
            - CoreVaultAccountProviderInformationKeyVaultDerivedNonExtended
              - …
            - CoreVaultAccountProviderInformationKeyVaultRandom
              - …
        - `type` 'Vault', required
      - `lock` 'Unlocked' | 'Locked' | 'Archived', required
      - `metadata` CoreEntityMetadata, required
        - `description` string
        - `revision` integer, required
        - `createdAt` string, date-time, required
        - `createdBy` CoreUserReference
          - `id` string, uuid, required
          - `domainId` string, uuid, required
        - `lastModifiedAt` string, date-time, required
        - `lastModifiedBy` CoreUserReference
          - `id` string, uuid, required
          - `domainId` string, uuid, required
        - `customProperties` CoreStringsMap, required
    - `signature` string, base64, required
    - `signingKey` string, base64, required
    - `additionalDetails` CoreAccountAdditionalDetails
      - `processing` union, required
        - CoreAccountProcessingDetailsCompleted
          - `status` 'Completed', required
        - CoreAccountProcessingDetailsInterrupted
          - `reason` string, required
          - `status` 'Interrupted', required
        - CoreAccountProcessingDetailsPending
          - `hint` 'TransientIssue' | 'InternalError'
          - `status` 'Pending', required
        - CoreAccountProcessingDetailsPreparing
          - `hint` 'TransientIssue' | 'InternalError'
          - `status` 'Preparing', required
        - CoreAccountProcessingDetailsRecovering
          - `hint` 'TransientIssue' | 'InternalError'
          - `status` 'Recovering', required
        - CoreAccountProcessingDetailsTracked
          - `status` 'Tracked', required
      - `lastBalancesUpdateRequestedAt` string, date-time
      - `lastBalancesUpdateProcessedAt` string, date-time
      - `ledgers` CoreApiAccountLedgerProcessing[], required
        - union
          - CoreApiAccountLedgerProcessingActivated
            - `ledgerId` string, required
            - `lastBalancesUpdateRequestedAt` string, date-time
            - `lastBalancesUpdateProcessedAt` string, date-time
            - `status` 'Activated', required
          - CoreApiAccountLedgerProcessingActivating
            - `ledgerId` string, required
            - `processing` union, required
              - …
            - `status` 'Activating', required
          - CoreApiAccountLedgerProcessingAvailable
            - `ledgerId` string, required
            - `status` 'Available', required
          - CoreApiAccountLedgerProcessingAwaitingLedgerActivation
            - `ledgerId` string, required
            - `status` 'AwaitingLedgerActivation', required
          - CoreApiAccountLedgerProcessingUnavailable
            - `ledgerId` string, required
            - `status` 'Unavailable', required
  - `count` integer, required
  - `currentStartingAfter` string
  - `nextStartingAfter` string

## Other responses

- `400` — One of: Domain locked (DomainLockedError); Requester locked (RequesterLockedError)
- `401` — One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)
- `404` — Entity or Domain not found (EntityNotFoundError)

---

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