Skip to content

Get Contact Generation Status

GET
/contacts/{contact_id}/documents/generation-status

Progress of this contact’s document generation. Reads only.

Named for the app route it proxies, which means the path contains generate - the tier heuristic reads that as an active GET and would publish a status poll as a credit spend. It is corrected by an explicit entry in build_scope_policy.py::READ_ONLY_ACTIVE_GET_ROUTES rather than by spelling the path around the matcher.

Authorizations

Parameters

Path Parameters

contact_id
required

Contact primary key.

integer

Contact primary key.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say “nothing to report” rather than “we did not tell you”.

object
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