v1
latestOpenAPI 3.0.12026-07-22231676.5 KBVault
List Vaults in the Recycle Bin
Lists every vault currently in the recycle bin for the current workspace. When a Vault project is deleted it is not purged immediately — it first moves to a workspace recycle bin, where it can be reviewed before being permanently deleted. Entries are ordered by deleted_at descending. This endpoint is restricted to workspace vault admins (the same permission as GET /api/v1/vault/workspace/projects).
get/api/v1/vault/workspace/recycle_bin
Query parameters
search_textstring
Case-insensitive substring filter on the vault name.
client_matter_idstring uuid
Restrict results to vaults associated with this client matter (the client matter UUID, not the human-readable matter number).
Response
Successfully retrieved recycle-bin entries for the workspace
Example response
{
"items": [
{
"id": "0197a1b2-3c4d-5e6f-7a8b-9c0d1e2f3a4b",
"resource_id": "abcdef12-3456-7890-abcd-ef1234567890",
"resource_type": "vault_project",
"recycle_bin_status": "deleted",
"deleted_at": "2026-07-15T18:42:10.512000Z",
"recycle_bin_purged_scheduled_at": "2026-08-14T18:42:10.512000Z",
"delete_source": "customer_delete",
"deleted_source_id": "12345678-1234-5678-1234-567812345678",
"deleted_by_user_email": "user@example.com",
"vault_project": {
"id": "abcdef12-3456-7890-abcd-ef1234567890",
"name": "Sample Contract Repository",
"client_matter_id": "11111111-2222-3333-4444-555555555555",
"created_at": "2024-12-04T01:22:03.584677",
"updated_at": "2025-03-25T14:49:45.612193",
"project_updated_at": "2025-02-14T19:29:50.549982",
"project_retained_at": "2026-02-14T19:29:50.549982",
"creator_email": "user@example.com",
"files_count": 4,
"size_bytes": 5325148,
"sharing": {
"user_shares": [
{
"created_at": "2024-01-16T13:45:00.000000",
"dest_user_email": "collaborator@example.com",
"dest_user_id": "11111111-2222-3333-4444-555566667777",
"dest_workspace_id": 2,
"permission_level": "VIEW",
"src_user_id": "12345678-1234-5678-1234-567812345678",
"src_workspace_id": 1,
"vault_folder_id": "87654321-8765-4321-8765-432187654321"
}
],
"workspace_count": 1,
"workspace_shares": [
{
"created_at": "2024-01-16T13:45:00.000000",
"dest_user_email": "collaborator@example.com",
"dest_user_id": "11111111-2222-3333-4444-555566667777",
"dest_workspace_id": 2,
"permission_level": "VIEW",
"src_user_id": "12345678-1234-5678-1234-567812345678",
"src_workspace_id": 1,
"vault_folder_id": "87654321-8765-4321-8765-432187654321"
}
]
}
}
}
],
"total": 1
}