# List vaults

Endpoint: GET /v1/vaults
Security: httpAuth

## Security:

  - `httpAuth` (unknown)
    http bearer

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

  - `sortOrder` (string)
    Sort order applied to the query results.

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

  - `publicKey` (string)
    Return entities matching given public key. It should be provided in Base64 format.

  - `lock` (array)
    Return entities matching given lock status.

  - `metadata.createdBy` (string)
    Return entities that were created by matching user.

  - `metadata.lastModifiedBy` (string)
    Return entities that were last modified by matching user.

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

  - `metadata.customProperties` (array)
    Return entities that contains provided custom properties.

  - `additionalDetails.processingStatus` (string)
    Return entities matching given processing status.

## Response 200 fields (application/json):

  - `items` (array, required)

  - `items.data` (object, required)

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

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

  - `items.data.parameters` (any)

  - `items.data.parameters.type` (string, required)
    Enum: "HSM", "MPC"

  - `items.data.parameters.backupEncryptionKey` (string)
    0x prefixed Hex encoded backup encryption key, supported key size between 2048 and 4096 bits.

  - `items.data.supportedDerivations` (array)

  - `items.data.enabledKeyStrategies` (array)

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

  - `items.data.lock` (string, required)
    Enum: "Unlocked", "Locked", "Archived"

  - `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.customProperties` (object, required)

  - `items.signature` (string, required)

  - `items.signingKey` (string, required)

  - `items.additionalDetails` (object)

  - `items.additionalDetails.processing` (any, required)

  - `items.additionalDetails.processing.status` (string, required)
    Enum: "Completed", "Pending", "Preparing"

  - `count` (integer, required)

  - `currentStartingAfter` (string)

  - `nextStartingAfter` (string)

## Response 400:

  - `400` (unknown)
    Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter alias, Invalid value for: query parameter publicKey, Invalid value for: query parameter lock, Invalid value for: query parameter metadata.createdBy, Invalid value for: query parameter metadata.lastModifiedBy, Invalid value for: query parameter metadata.description, Invalid value for: query parameter metadata.customProperties, Invalid value for: query parameter additionalDetails.processingStatus

## Response 401:

  - `401` (unknown)
    One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)

## Response 401 fields (application/json):

  - `reason` (string, required)

  - `message` (string)