Sign in

v1

latestOpenAPI 3.0.12026-07-22231676.5 KB
Vault

List Vault Projects and Knowledge Bases

Lists all Vault projects and knowledge bases in the current workspace with pagination support. This endpoint returns a paginated list of projects that the authenticated user has permission to view.

get/api/v1/vault/workspace/projects

Query parameters

pageinteger

Page number for pagination (default: 1)

per_pageinteger

Number of items per page (default: 20, max: 100)

namestring

Case-insensitive substring match on project name.

is_knowledge_baseboolean

Filter by knowledge base flag. true returns only knowledge base projects, false excludes them, and omitting the parameter returns both.

created_afterinteger

Inclusive lower bound on project creation time, expressed as a UTC Unix epoch timestamp in seconds. Only projects with created_at >= created_after are returned. Must be strictly less than created_before when both are provided.

created_beforeinteger

Exclusive upper bound on project creation time, expressed as a UTC Unix epoch timestamp in seconds. Only projects with created_at < created_before are returned.

sort_by'date' | 'name'

Field to sort the results by. date sorts by the project's last content-update timestamp (the default ordering). name sorts alphabetically by project name.

sort_order'asc' | 'desc'

Sort direction to order results list.

Response

Successfully retrieved workspace projects

Example response

{
  "response": {
    "content": {
      "projects": [
        {
          "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"
              }
            ]
          }
        }
      ],
      "pagination": {
        "page": 3,
        "per_page": 20,
        "total": 45,
        "total_pages": 3
      }
    }
  }
}