v2
latestOpenAPI 3.1.02026-08-05123191254.3 KBGet Deal Document
Get metadata for a single document on a deal.
Resolves across all the deal's vaults by default. Pass vault_id to pin the lookup to a specific vault — necessary when the same document lives in more than one vault (e.g. a Resources doc curated into a Deal Room), so the returned vault tag and folder_path describe the vault the caller selected rather than an arbitrary one.
Path parameters
Query parameters
Comma-separated sparse fieldset
Comma-separated sparse fieldset
Comma-separated relationship includes
Comma-separated relationship includes
Number of results to return (1-200, clamped)
Number of results to return (1-200, clamped)
Offset for pagination (>= 0, clamped)
Offset for pagination (>= 0, clamped)
Base64 cursor for pagination
Base64 cursor for pagination
Case-insensitive substring match on the document file name.
Case-insensitive substring match on the document file name.
Filter to a single file extension, e.g. pdf (no leading dot).
Filter to a single file extension, e.g. pdf (no leading dot).
Only documents directly inside this folder. Omit for the whole vault.
Only documents directly inside this folder. Omit for the whole vault.
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