Overview
Folders help organize personal vault items. They are user-specific and not shared across organizations.Folders are only available for personal vault items, not organization items.
Get Folder
Retrieve a specific folder by ID.The folder ID
Response
Folder unique identifier
Encrypted folder name
Last modification timestamp
List All Folders
Retrieve all folders for the authenticated user.Response
Returns a list of all folders belonging to the user.Create Folder
Create a new folder.Request Body
Encrypted folder name
Response
Returns the created folder object with its generated ID.Update Folder
Update an existing folder’s name.The folder ID to update
Request Body
New encrypted folder name
Delete Folder
Delete a folder permanently.The folder ID to delete
Delete All Folders
Delete all folders for the authenticated user.Folder Organization
Best Practices
- Use Descriptive Names: Name folders clearly to easily find items
- Don’t Nest: Folders are flat - use naming conventions like “Work - Email” for logical grouping
- Limit Count: Too many folders can make organization difficult
- Use Collections Instead: For shared items, use organization collections
Folders vs Collections
| Feature | Folders | Collections |
|---|---|---|
| Scope | Personal items only | Organization items |
| Sharing | Not shared | Shared with groups/users |
| Permissions | User has full control | Role-based access |
| Visibility | User only | Organization members |
Encryption
Folder names are encrypted client-side before being sent to the server.
name field must be encrypted using the user’s encryption key. The format is: