get https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id//vaults/by-external-keys
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:
- Department & Region Filtering: Find all finance department vaults in the north region with pagination
- User-Specific Filtering: Get vaults for a specific user that match certain criteria
- Invitation-Based Access: Filter vaults accessible via invitation codes
- Federation Integration: Access vaults through federated identity systems
- 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:
- If federationId provided: Resolves to OpenID or treats as invitationCode
- If userId provided: Direct user vault lookup
- If invitationCode provided: Invitation-based vault access
- 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