Types

ApprovalRequest

An approval request: one deal or invitation moving through its organisation's approval steps.

idrequired
string (uuid)
The deal UUID for opportunity, or the invite UUID for invite.
typerequired
string
One of: opportunity, invite
workflow_typerequired
string
The workflow type the request follows.One of: internal_publish, provider_approval, incoming_connect, internal_provider_publish, client_invite
staterequired
string
rejected when the request was refused. approved when the last step on the path has completed. Otherwise pending. Completion is vote-computed only, never read from the deal or invite status.One of: pending, approved, rejected
current_step_idrequired
integer | null
The step waiting for votes or for a route choice. Null once approved; when rejected, the step being voted on at the time.
supersededrequired
boolean
True when the organisation has replaced the workflow since the request began. The steps shown are the ones the request follows.
stepsrequired
Every step of the tree, parents before their children.
choicesrequired
The routes chosen where a step leads to several next steps.
created_atrequired
string | null (date-time)
When the request started. Null for an invite request recorded without a date.
updated_atrequired
string (date-time)

Used by (1)