Deal ManagementDeal

Get the analyst-authored deal document from Liveblocks

Reads the deal’s Liveblocks room and returns its structured contents: the narrative document body (headings, prose, section briefs, key-finding callouts, chart references), the comment threads, and chart annotations. Chart numbers are not stored here (only references); fetch figures via the data endpoints. Returns an empty body for a deal with no document yet.

Authentication

AuthorizationBearer

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

Path parameters

group_idintegerRequired
deal_idintegerRequired

Response

Successful Response
room_idstring
Liveblocks room id the content was read from
bodystring

Reading-order markdown of the document narrative

titlestring or nullOptional

Document title (first h1 heading), if present

commentslist of objectsOptional
Flattened comment threads
chart_annotationslist of objectsOptional
Annotations pinned to charts in the document
truncatedbooleanOptionalDefaults to false
Whether the document body was truncated to a size bound

Errors

422
Unprocessable Entity Error