R4

List Vault Items

Returns all non-archived items in a vault with basic metadata and field counts.

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)

{
  "items": [
    {
      "id": "507f1f77bcf86cd799439021",
      "name": "Production Database",
      "type": "LOGIN",
      "websites": ["https://db.example.com"],
      "createdAt": "2026-01-20T14:00:00.000Z",
      "fieldCount": 4
    },
    {
      "id": "507f1f77bcf86cd799439022",
      "name": "AWS Root Credentials",
      "type": "API_KEY",
      "websites": ["https://console.aws.amazon.com"],
      "createdAt": "2026-01-22T09:30:00.000Z",
      "fieldCount": 2
    }
  ],
  "vaultId": "507f1f77bcf86cd799439011",
  "count": 2
}

Response Fields

FieldTypeDescription
itemsarrayArray of vault item summaries
items[].idstringVault item ID
items[].namestringVault item name
items[].typestring | nullItem type: LOGIN, API_KEY, DATABASE, SSH_KEY, SERVER, SECURE_NOTE, CREDIT_CARD, CUSTOM
items[].websitesstring[]Associated website URLs
items[].createdAtstringISO 8601 creation timestamp
items[].fieldCountnumberNumber of non-archived fields on the item
vaultIdstringThe vault ID these items belong to
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
  • Field values are not included in the list response — use the Get Vault Item Detail endpoint to retrieve values
  • 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