List Vault Items

Returns all non-archived items in a vault with basic metadata, vault-level checkpoint metadata, and the item-group structure needed for zero-trust verification.

GET /api/v1/machine/vault/:vaultId/items

Headers

HeaderTypeRequiredDescription
X-API-KeystringYesYour API key

Path Parameters

ParameterTypeRequiredDescription
vaultIdstringYesThe unique identifier of the vault

Response

Success (200 OK)

{
  "vaultId": "507f1f77bcf86cd799439011",
  "vaultName": "Production Secrets",
  "dataClassification": "CONFIDENTIAL",
  "currentDekVersion": 3,
  "summaryCheckpoint": {
    "checkpoint": {
      "vaultId": "507f1f77bcf86cd799439011",
      "version": 9,
      "name": "Production Secrets",
      "dataClassification": "CONFIDENTIAL",
      "currentDekVersion": 3,
      "items": [
        {
          "id": "507f1f77bcf86cd799439021",
          "name": "Production Database",
          "type": "LOGIN",
          "websites": ["https://db.example.com"],
          "groupId": null
        }
      ],
      "groups": []
    },
    "signerUserKeyPairId": "507f1f77bcf86cd799439099",
    "signature": "base64-signature"
  },
  "items": [
    {
      "id": "507f1f77bcf86cd799439021",
      "name": "Production Database",
      "type": "LOGIN",
      "websites": ["https://db.example.com"],
      "groupId": null,
      "createdAt": "2026-01-20T14:00:00.000Z",
      "fieldCount": 4
    },
    {
      "id": "507f1f77bcf86cd799439022",
      "name": "AWS Root Credentials",
      "type": "API_KEY",
      "websites": ["https://console.aws.amazon.com"],
      "groupId": null,
      "createdAt": "2026-01-22T09:30:00.000Z",
      "fieldCount": 2
    }
  ],
  "vaultItemGroups": [],
  "count": 2
}

Response Fields

FieldTypeDescription
vaultIdstringThe vault ID these items belong to
vaultNamestringThe current vault name used when reconstructing the signed summary checkpoint. This metadata is not end-to-end encrypted.
dataClassificationstring | nullCurrent vault data classification
currentDekVersionnumber | nullCurrent vault DEK version bound into the signed summary checkpoint
summaryCheckpointobject | nullSigned vault summary checkpoint that authenticates the returned item/group metadata
summaryCheckpoint.checkpoint.versionnumberMonotonic summary-checkpoint version for rollback detection
summaryCheckpoint.signerUserKeyPairIdstringUser key pair ID that signed the checkpoint
summaryCheckpoint.signaturestringRSA-PSS signature over the canonical summary payload
itemsarrayArray of vault item summaries
items[].idstringVault item ID
items[].namestringVault item name. This metadata is not end-to-end encrypted.
items[].typestring | nullItem type: LOGIN, API_KEY, DATABASE, SSH_KEY, SERVER, SECURE_NOTE, CREDIT_CARD, CUSTOM
items[].websitesstring[]Associated website URLs. This metadata is not end-to-end encrypted.
items[].groupIdstring | nullVault item group ID referenced by the summary checkpoint
items[].createdAtstringISO 8601 creation timestamp
items[].fieldCountnumberNumber of non-archived fields on the item
vaultItemGroupsarrayVault item groups referenced by the returned items
countnumberTotal number of items returned

Error Responses

404 Not Found - Vault not found or not accessible

{
  "error": {
    "code": "vault_not_found",
    "message": "The vault with ID \"507f1f77bcf86cd799439011\" was not found or you do not have access to it."
  }
}

Example Request

curl -X GET "https://r4.dev/api/v1/machine/vault/507f1f77bcf86cd799439011/items" \
  -H "X-API-Key: rk_abc123def456.ghijklmnopqrstuvwxyz"

Notes

  • Only non-archived items are returned
  • vaultName, item names, and websites are metadata, so they are not end-to-end encrypted
  • Field values are not included in the list response — use the Get Vault Item Detail endpoint to retrieve values
  • Zero-trust clients should verify summaryCheckpoint against GET /vault/:vaultId/public-keys before trusting item names, websites, or group structure
  • Use fieldCount to understand the complexity of each item before fetching full details

Use Cases

  • Vault browsing: List items to find the one you need before fetching full details
  • Inventory: Audit what secrets exist in a vault
  • Sync: Compare item lists across environments for drift detection