Vaults

List vaults

Lists the user's active vaults with their note and attachment counts. Pass deleted=true to list soft-deleted vaults instead, or user_code to also report user_code_valid and a suggested_vault_name for an in-progress device link.

get/api/vaults

Request

  • Base URL: https://api.engram.page
  • URL: https://api.engram.page/api/vaults
  • Auth: HTTP bearer

Query parameters

deletedstring

Pass "true" to list soft-deleted vaults instead of active ones.

user_codestring

Device-link user code; echoes a suggested_vault_name.

Response

Vaults

access_levelsboolean

True when this server supports per-vault access levels and mcp:read on OAuth grants and API keys. Absent on servers that predate them.

suggested_device_namestring nullable

Present only when a user_code query param is supplied. The name the plugin suggested for its device (hostname or platform), for a default connection label. Null when the code is invalid or the plugin sent none.

suggested_vault_namestring nullable

Present only when a user_code query param is supplied (device-link flow). May be null for a perfectly valid code — check user_code_valid, not this.

user_code_validboolean

Present only when a user_code query param is supplied. True when the code is real, still pending, unexpired, and claimable by the calling user. This is the validity signal; a null suggested_vault_name is not.

Changes

No recorded changes to this operation across all 1 revision of this API.