Contacts

Get Contact 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.

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

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/contacts/{contact_id}/documents/generation-status
  • Auth: HTTP bearer

Path parameters

contact_idinteger required

Contact primary key.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataCrmRecordPayload 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".

Changes

No recorded changes to this operation across all 2 revisions of this API.