Skip to content

List Deal Documents

GET
/deals/{deal_id}/documents

Every generated document on this deal, newest first.

Carries each document’s body, so it is the wrong read for a poll loop - use /documents/generation-status for that.

Authorizations

Parameters

Path Parameters

deal_id
required

Deal id (UUID).

string

Deal id (UUID).

Query Parameters

folder
Any of:
string

strategy or analysis. Not validated by the app - an unrecognised folder matches nothing rather than failing.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

items is always present and always the list, whichever key the app used for it - so a caller can page one way rather than learning six key names.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string