# List accounts

Endpoint: GET /v1/domains/{domainId}/accounts
Security: httpAuth

## Path parameters:

  - `domainId` (string, required)
    Unique identifier for the domain.

## Query parameters:

  - `limit` (integer)
    The number of entities to return.

  - `startingAfter` (string)
    Entity id used to the determine beginning of query results.

  - `sortBy` (string)
    Property name used to sort the query results.
    Enum: "id", "alias", "ledgerId", "lock", "metadata.createdAt", "metadata.lastModifiedAt"

  - `sortOrder` (string)
    Sort order applied to the query results.
    Enum: "ASC", "DESC"

  - `ledgerId` (string)
    Return entities matching given default ledger id.
    Example: "1234567"

  - `alias` (string)
    Return entities with aliases that contains or equals to provided alias.
    Example: "alias1"

  - `providerDetails.vaultId` (string)
    Return entities matching given vault id.
    Example: "8e92eb53-40e7-4809-bb52-7e7b3b41a4be"

  - `metadata.createdBy` (string)
    Return entities that were created by matching user.
    Example: "fdeeeb4b-f987-4ec4-9880-1eb280581d49"

  - `metadata.lastModifiedBy` (string)
    Return entities that were last modified by matching user.
    Example: "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b"

  - `metadata.description` (string)
    Return entities with descriptions that contains or equals to provided description.
    Example: "description1"

  - `metadata.customProperties` (array)
    Return entities that contains provided custom properties.
    Example: ["key1:value1","key2:value2"]

  - `lock` (array)
    Return entities matching given lock status(/-es).
    Enum: "Unlocked", "Locked", "Archived"

  - `additionalDetails.ledgers.ledgerId` (array)
    Return entities given ledger id.
    Example: ["bitcoin","bitcoin-testnet"]

  - `additionalDetails.ledgers.status` (array)
    Return entities having a ledger matching given status.
    Enum: "Activating", "AwaitingLedgerActivation", "Activated"

  - `additionalDetails.processingStatus` (string)
    Return entities matching given processing status.
    Enum: "Pending", "Preparing", "Tracked", "Recovering", "Completed", "Interrupted"

## Response 200 fields (application/json):

  - `items` (array, required)

  - `items.data` (object, required)

  - `items.data.id` (string, required)

  - `items.data.domainId` (string, required)

  - `items.data.alias` (string, required)

  - `items.data.ledgerId` (string)

  - `items.data.providerDetails` (any, required)
    - `vaultId` (string, required)
    - `keyStrategy` (string, required)
      Enum: "VaultHard", "VaultSoft", "Random"
    - `keys` (array) — one of (discriminator: type):
      - VaultDerived:
        - `id` (string, required)
          Enum: "SECP256K1_CUSTODY_1", "ED25519_CUSTODY_1", "ED25519_CUSTODY_2", "ED25519_STAKING_1"
        - `derivationPath` (string, required)
        - `publicKey` (any)
          - `value` (string, required)
          - `chainCode` (string, required)
          - `type` (string, required)
            Enum: "ExtendedPublicKey"
        - `type` (string, required)
          Enum: "VaultDerived"
      - VaultDerivedNonExtended:
        - `id` (string, required)
          Enum: same as `id` in "VaultDerived" (4 values)
        - `derivationPath` (string, required)
        - `publicKey` (any, required)
          - `value` (string, required)
          - `type` (string, required)
            Enum: "PublicKey"
        - `type` (string, required)
          Enum: "VaultDerivedNonExtended"
      - VaultRandom:
        - `id` (string, required)
          Enum: same as `id` in "VaultDerived" (4 values)
        - `publicKey` (any) — one of (discriminator: type):
          - ExtendedPublicKey:
            - `value` (string, required)
            - `chainCode` (string, required)
            - `type` (string, required)
              Enum: same as `type` (1 values)
          - PublicKey:
            - `value` (string, required)
            - `type` (string, required)
              Enum: same as `type` (1 values)
        - `type` (string, required)
          Enum: "VaultRandom"
    - `type` (string, required)
      Enum: "Vault"
    - `keyInformation` (any, required) — one of (discriminator: type):
      - Random:
        - `publicKey` (any) — one of (discriminator: type):
          - ExtendedPublicKey:
            - `value` (string, required)
            - `chainCode` (string, required)
            - `type` (string, required)
              Enum: same as `type` (1 values)
          - PublicKey:
            - `value` (string, required)
            - `type` (string, required)
              Enum: same as `type` (1 values)
        - `type` (string, required)
          Enum: "Random"
      - VaultDerived:
        - `publicKey` (any) — one of (discriminator: type):
          - ExtendedPublicKey:
            - `value` (string, required)
            - `chainCode` (string, required)
            - `type` (string, required)
              Enum: same as `type` (1 values)
          - PublicKey:
            - `value` (string, required)
            - `type` (string, required)
              Enum: same as `type` (1 values)
        - `derivationPath` (string, required)
        - `type` (string, required)
          Enum: same as `type` in "VaultDerived" (1 values)

  - `items.data.lock` (string, required)
    Enum: same as `lock` (3 values)

  - `items.data.metadata` (object, required)

  - `items.data.metadata.description` (string)

  - `items.data.metadata.revision` (integer, required)

  - `items.data.metadata.createdAt` (string, required)

  - `items.data.metadata.createdBy` (object)

  - `items.data.metadata.createdBy.id` (string, required)

  - `items.data.metadata.createdBy.domainId` (string, required)

  - `items.data.metadata.lastModifiedAt` (string, required)

  - `items.data.metadata.lastModifiedBy` (object)

  - `items.data.metadata.customProperties` (object, required)

  - `items.signature` (string, required)

  - `items.signingKey` (string, required)

  - `items.additionalDetails` (object)

  - `items.additionalDetails.processing` (any, required) — one of (discriminator: status):
    - Completed:
      - `status` (string, required)
        Enum: "Completed"
    - Interrupted:
      - `reason` (string, required)
      - `status` (string, required)
        Enum: "Interrupted"
    - Pending:
      - `hint` (string)
        Enum: "TransientIssue", "InternalError"
      - `status` (string, required)
        Enum: "Pending"
    - Preparing:
      - `hint` (string)
        Enum: same as `hint` in "Pending" (2 values)
      - `status` (string, required)
        Enum: "Preparing"
    - Recovering:
      - `hint` (string)
        Enum: same as `hint` in "Pending" (2 values)
      - `status` (string, required)
        Enum: "Recovering"
    - Tracked:
      - `status` (string, required)
        Enum: "Tracked"

  - `items.additionalDetails.ledgers` (array, required) — one of (discriminator: status):
    - Activated:
      - `ledgerId` (string, required)
      - `lastBalancesUpdateRequestedAt` (string)
      - `lastBalancesUpdateProcessedAt` (string)
      - `status` (string, required)
        Enum: "Activated"
    - Activating:
      - `ledgerId` (string, required)
      - `processing` (any, required) — one of (discriminator: status):
        - Pending:
          - `hint` (string)
            Enum: same as `hint` in "Pending" (2 values)
          - `status` (string, required)
            Enum: same as `status` in "Pending" (1 values)
        - Preparing:
          - `hint` (string)
            Enum: same as `hint` in "Pending" (2 values)
          - `status` (string, required)
            Enum: same as `status` in "Preparing" (1 values)
        - Recovering:
          - `hint` (string)
            Enum: same as `hint` in "Pending" (2 values)
          - `status` (string, required)
            Enum: same as `status` in "Recovering" (1 values)
        - Tracked:
          - `hint` (string)
            Enum: same as `hint` in "Pending" (2 values)
          - `status` (string, required)
            Enum: same as `status` in "Tracked" (1 values)
      - `status` (string, required)
        Enum: "Activating"
    - Available:
      - `ledgerId` (string, required)
      - `status` (string, required)
        Enum: "Available"
    - AwaitingLedgerActivation:
      - `ledgerId` (string, required)
      - `status` (string, required)
        Enum: "AwaitingLedgerActivation"
    - Unavailable:
      - `ledgerId` (string, required)
      - `status` (string, required)
        Enum: "Unavailable"

  - `items.additionalDetails.lastBalancesUpdateRequestedAt` (string)

  - `items.additionalDetails.lastBalancesUpdateProcessedAt` (string)

  - `count` (integer, required)

  - `currentStartingAfter` (string)

  - `nextStartingAfter` (string)

## Response 400 fields (application/json):

  - `reason` (string, required)

  - `message` (string)