List Vaults by combination of external keys with optional user identifier and pagination

This endpoint allows filtering vaults by a combination of external keys with optional user identification and cursor-based pagination.

Key Features:

  • Filter vaults by multiple external key-value pairs (AND operation)
  • Optional user identification via userId, federationId, or invitationCode
  • Cursor-based pagination with limit, startingAfter, and endingBefore parameters
  • Fallback to tenant-wide vault listing when no identifier provided
  • Supports complex filtering scenarios for multi-dimensional vault organization

Pagination Parameters:

  • limit: Number of results per page (default: 20, max: 100)
  • startingAfter: Object ID to start pagination after (for next page)
  • endingBefore: Object ID to end pagination before (for previous page)

Response Format:

      {
        "data": [.], // Array of vault objects
        "hasMore": true, // Whether more results are available
        "totalCount": 150 // Total number of matching vaults (when available)
      }

Use Cases:

  1. Department & Region Filtering: Find all finance department vaults in the north region with pagination
  2. User-Specific Filtering: Get vaults for a specific user that match certain criteria
  3. Invitation-Based Access: Filter vaults accessible via invitation codes
  4. Federation Integration: Access vaults through federated identity systems
  5. Tenant-Wide Search: Search all tenant vaults with specific external key combinations

External Keys Logic:

  • All provided external key filters must match (AND operation)
  • Each vault's external keys are checked against the filter criteria
  • Empty external keys array returns all vaults (no filtering applied)

User Identification Priority:

  1. If federationId provided: Resolves to OpenID or treats as invitationCode
  2. If userId provided: Direct user vault lookup
  3. If invitationCode provided: Invitation-based vault access
  4. If none provided: Tenant-wide vault search

Pagination Notes:

  • Filing cabinet fallback scenarios may not support full pagination
  • When falling back to filing cabinets, results are aggregated and pagination is limited
Path Params
string
required

Tenant identifier.

Query Params
string

Limit. Default value is 20.

string

Starting after is an object ID that defines your place in the list.

string

Object identifier that defines your place in the list.

string

External key name for filtering vaults. Common keys include department, region, project, Team, etc.

Validation Rules:

  • Must be a non-empty string when provided
  • Maximum length: 100 characters
  • Minimum length: 1 character
  • Only alphanumeric characters, hyphens, underscores, and dots allowed
  • Case-sensitive matching
string

External key value to match exactly. Case-sensitive string matching.

Validation Rules:

  • Must be a non-empty string when provided
  • Maximum length: 500 characters
  • Minimum length: 1 character
  • Supports alphanumeric characters, spaces, and common special characters
  • Case-sensitive matching
string

User identifier (OpenID) to filter vaults by. When provided, only vaults associated with this specific user will be returned.

Important: Only one of userId, federationId, or invitationCode should be provided.

string

This is only applicable for enterprise implementations. The federationId identifies the institution.

string

The Invitation code to the entity.

Response
200

Successfully retrieved paginated vaults matching the specified criteria.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!