Skip to main content
GET
/
api
/
v1
/
vault
/
workspace
/
projects
List Vault Projects and Knowledge Bases
curl --request GET \
  --url https://api.harvey.ai/api/v1/vault/workspace/projects \
  --header 'Authorization: Bearer <token>'
{
  "response": {
    "content": {
      "pagination": {
        "page": 1,
        "per_page": 20,
        "total": 150,
        "total_pages": 8
      },
      "projects": [
        {
          "created_at": "2024-01-15T10:30:00.000000",
          "creator_email": "user@example.com",
          "files_count": 109,
          "id": "12345678-1234-5678-1234-567812345678",
          "is_knowledge_base_project": false,
          "name": "Example Legal Project",
          "project_updated_at": "2024-01-20T14:45:00.000000",
          "query_count": 30,
          "sharing": {
            "user_count": 0,
            "user_shares": [],
            "workspace_count": 0,
            "workspace_shares": []
          },
          "size_bytes": 104857600,
          "updated_at": "2024-01-20T14:45:00.000000"
        },
        {
          "created_at": "2024-01-10T09:15:00.000000",
          "creator_email": "user@example.com",
          "files_count": 45,
          "id": "87654321-8765-4321-8765-432187654321",
          "is_knowledge_base_project": true,
          "name": "Knowledge Base Project",
          "project_updated_at": "2024-01-18T11:20:00.000000",
          "query_count": 15,
          "sharing": {
            "user_count": 2,
            "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-17T16:30:00.000000",
                "dest_workspace_id": 3,
                "permission_level": "EDIT",
                "src_user_id": "12345678-1234-5678-1234-567812345678",
                "src_workspace_id": 1,
                "vault_folder_id": "87654321-8765-4321-8765-432187654321"
              }
            ]
          },
          "size_bytes": 52428800,
          "updated_at": "2024-01-18T11:20:00.000000"
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.harvey.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Permissions

Requires View workspace projects permission.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:1

Page number for pagination (default: 1)

Required range: x >= 1
​
per_page
integer
default:20

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

Required range: 1 <= x <= 100
​
name
string

Case-insensitive substring match on project name.

Maximum string length: 256
​
is_knowledge_base
boolean

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

​
created_after
integer<int64>

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_before
integer<int64>

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
enum<string>
default:date

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.

Available options:
date,
name
​
sort_order
enum<string>
default:desc

Sort direction to order results list.

Available options:
asc,
desc

Response

Successfully retrieved workspace projects

​
response
object