List Deal Memos

List the memos (document-generation deal books) for a deal.

Returns both published memos and unpublished drafts so callers can support preview-your-own-work flows; each row carries status ("draft" | "published") and published_at to disambiguate. Authorizes the deal first (404 when inaccessible), then filters the deal's memos through the DOCUMENT_GENERATION_STRUCTURE READ policy so a caller who reaches the deal via shared-vault access only sees memos that were actually shared into their vault (the memo policy's two strategies are deal-membership and shared-vault, OR'd at query level). PDF download links are omitted here — fetch a single memo for signed pdf_url links.

Where the deal documents/vaults surface is enabled for the caller, each memo is tagged with vaults — the {id, type, title} of the vaults it lives in, scoped to the caller's visible vaults (a subset of GET /deals/{deal_id}/vaults; empty when none are visible). vault_id scopes the list to the memos in a single vault (a vault id not on this deal 404s). Both are inert until that surface is enabled, so vault names don't surface ahead of its launch.

deal_idinteger required

limitinteger

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

offsetinteger

Offset for pagination (>= 0, clamped)

searchstring nullable

Case-insensitive substring search on memo title.

vault_idinteger nullable

Drill into one vault on this deal (use the id from GET /deals/{deal_id}/vaults) to list only the memos in it. Omit to list the deal's memos across all vaults. A vault id that does not belong to this deal 404s. Effective only where the deal documents/vaults surface is enabled.

Response

Successful Response

request_idstring required

timestampstring required

{"stackTrail":"components:schemas:MemoListResponse:properties:pagination","oasType":"schema","type":"unknown","title":"Pagination"}

v3

List Deal Memos

Path parameters

Query parameters

Response