HAharvey
Vault

List Files in a Vault Project

Lists files within a single vault project, with filtering and sorting supported.

Pagination. Omit cursor on the first request. Subsequent requests should pass back the next_cursor value returned in the previous response. Continue until has_more is false.

get/api/v1/vault/projects/{project_id}/files

Request

Path parameters

project_idstring uuid required

The unique identifier of the vault project

Query parameters

cursorstring

Opaque pagination cursor returned in the previous response's next_cursor field. Omit on the first request.

limitinteger

Maximum number of files to return per page.

namestring

Case-insensitive substring match on file name. % and _ are treated as literals, not SQL LIKE wildcards.

content_typestring[]

Filter by MIME type. Repeat the query parameter to match any of multiple values (e.g. ?content_type=application/pdf&content_type=text/plain). Up to 20 values, each at most 256 characters.

processing_statusstring[]

Filter by processing status. Repeat the query parameter to match any of multiple values. Accepted case-insensitively (READY_TO_QUERY and ready_to_query are equivalent). Internal-only statuses are rejected. Up to 20 values.

uploaded_afterinteger

Inclusive lower bound on the file's upload time, as a UTC Unix epoch timestamp in seconds. Must be strictly less than uploaded_before when both are provided.

uploaded_beforeinteger

Inclusive upper bound on the file's upload time, as a UTC Unix epoch timestamp in seconds.

sort_by'name' | 'uploaded_at' | 'size'

Field to sort the results by. Accepted case-insensitively.

sort_order'asc' | 'desc'

Sort direction. Accepted case-insensitively. Results include the file id as a deterministic tiebreaker so cursor-paginated ordering is stable across pages.

Response

Successfully retrieved project files

Example response

{
  "response": {
    "content": {
      "files": [
        {
          "id": "018e38dc-8726-7bc2-af5d-bdd5d04c84ec",
          "name": "engagement_letter.pdf",
          "content_type": "application/pdf",
          "processing_status": "READY_TO_QUERY",
          "size": 184320,
          "uploaded_at": 1767225600
        }
      ],
      "pagination": {
        "page_size": 20,
        "has_more": true,
        "next_cursor": "eyJsYXN0X2ZpbGVfaWQiOiAiMDE5OWM1YzEtNTBkOS03ZDYwLTkzYWEtY2Q2NWMzYjdkNWE5In0=",
        "total_count": 137
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.