Sign in

v2

OpenAPI 3.1.02026-08-05123191254.3 KB
external-v2-documents

List Deal Documents

List a deal's documents across all its vaults, or one via vault_id.

Each document is tagged with the vault it lives in. vault_id drills into a single vault; a vault id that does not belong to this deal 404s (indistinguishable from a nonexistent one — no leak/oracle).

get/api/external/v2/deals/{deal_id}/documents

Path parameters

deal_idinteger required

Query parameters

fieldsstring nullable

Comma-separated sparse fieldset

Comma-separated sparse fieldset

includestring nullable

Comma-separated relationship includes

Comma-separated relationship includes

limitinteger

Number of results to return (1-200, clamped)

Number of results to return (1-200, clamped)

offsetinteger

Offset for pagination (>= 0, clamped)

Offset for pagination (>= 0, clamped)

cursorstring nullable

Base64 cursor for pagination

Base64 cursor for pagination

searchstring nullable

Case-insensitive substring match on the document file name.

Case-insensitive substring match on the document file name.

extensionstring nullable

Filter to a single file extension, e.g. pdf (no leading dot).

Filter to a single file extension, e.g. pdf (no leading dot).

folder_idinteger nullable

Only documents directly inside this folder. Omit for the whole vault.

Only documents directly inside this folder. Omit for the whole vault.

vault_idinteger nullable

Drill into one vault on this deal (use the id from GET /deals/{deal_id}/vaults). Omit to list documents across all of the deal's vaults. A vault id that does not belong to this deal 404s.

Drill into one vault on this deal (use the id from GET /deals/{deal_id}/vaults). Omit to list documents across all of the deal's vaults. A vault id that does not belong to this deal 404s.

Response

Successful Response

request_idstring required
timestampstring required