GetWorkflowInfoResp

Full workflow as returned by GET /workflows/{id}. Carries identity, source reference, status, audit fields, participants, envelopes, and step runs. The HTTP ETag header on the response carries the version handle used for If-Match on PUT /workflows/{id} and PATCH /workflows/{id}/entities.

envelopes
Type: array object[]
required

Runtime state per envelope — current status, the rendered documents, and references to combined / signed / certificate file artifacts.
- key
  Type: string
  required
  
  Envelope key, matching the envelope key declared on the workflow's blueprint.
- resolvedDocuments
  Type: array object[] · WorkflowDocumentInfo[]
  required
  
  Documents that have actually been rendered for this envelope (one per declared document, plus iterator expansions if the blueprint uses one).
  
  A single document slot inside an envelope. Carries the slot identifier (key) plus the workflow-runtime payload supplied at create time and editable during workflow review (fieldOverrides, adhocFields, inputMap). Template-derived metadata (template identity, template fields, inputs, roles, file pointer) is not included here — fetch the source template directly via GET /templates/{key}?version={version} if you need it.
- status
  Type: stringenum
  required
  
  Current envelope status.
  
  values
  pending
  in_progress
  completed
  voided
  failed
- certificateFileId
  Type: string
  
  File ID of the signing certificate / audit trail PDF. Absent until signing completes.
- signedDocumentFileId
  Type: string
  
  File ID of the final signed PDF. Absent until all participants have signed.
id
Type: string Pattern: ^wf_[0-9a-z]{26}$
required

Unique ID of the workflow. Prefixed lowercase ULID, e.g. wf_01jv8m7qfj6xj9gkz7a4s2h8e.
mode
Type: stringenum
required

Mode the namespace this workflow runs in. test-mode workflows are isolated from live data and don't bill against your live volume.
values
- test
- live
participants
Type: array object[] · ParticipantInfo[]
required

Concrete people resolved into participant slots — what blueprint role expressions evaluated to plus any creation-time overrides.
- key
  Type: string
  required
- email
  Type: string
- name
  Type: string
senderInfo
Type: object
required

Sender block applied to participant emails and the signing UI. Comes from this workflow's options.senderInfoOverrides (if supplied at create time), otherwise from the namespace's defaults.
- company
  Type: string
  required
  
  Company name shown alongside the sender name.
- email
  Type: string
  required
  
  Reply-to address surfaced to participants.
- logoUrl
  Type: string
  required
  
  Logo image rendered in participant emails and the signing UI header.
- name
  Type: string
  required
  
  Display name shown as the sender on participant emails and the signing UI.
- senderEmail
  Type: string
  required
  
  Technical envelope-from address (taken from the namespace; not overridable per workflow).
- address
  Type: string
  
  Optional contact mailing address shown in the signing UI footer.
- phone
  Type: string
  
  Optional contact phone number shown in the signing UI footer.
source
required

Where the workflow was instantiated from. Use the type discriminator to branch — see each variant below for its identity payload.
Instantiated from a stored, named blueprint in this namespace. The blueprint object carries the resolvable identity — fetch the source via the blueprint resource APIs.
type
Discriminator
enum
const:
blueprint
required
values
blueprint
blueprint
Type: object
required
status
Type: stringenum
required

Current workflow status. completed, failed, declined, and voided are terminal.
values
- pending
- in_progress
- completed
- failed
- declined
- voided
stepRuns
Type: array object[]
required

Flat list of step runs — one entry per step in the workflow's blueprint orchestration tree. Each entry carries the step's current status and any participant-action state for participant steps.
- key
  Type: string
  required
  
  Step key, matching the step declared on the workflow's blueprint.
- status
  Type: stringenum
  required
  
  Current step status. completed and skipped count as done for parent group-step completion.
  
  values
  pending
  in_progress
  completed
  skipped
  failed
- participantAction
  Type: object
  
  Present only for participant steps. Tracks the participant's progress through the signing flow.
completedAt
Type: stringFormat: date-time

When the workflow reached completed status. Absent for non-completed workflows.
declinedAt
Type: stringFormat: date-time

When a participant declined the workflow. Absent for non-declined workflows.
declineReason
Type: string

Reason the participant supplied when declining. Absent for non-declined workflows or when no reason was supplied.
description
Type: string

Optional human-readable description.
idempotencyKey
Type: string

Caller-supplied Idempotency-Key header value from POST /workflows, if one was provided.
inputEntities
Type: array object[]

Lightweight summary of the entities supplied at workflow create time — each entry carries the entity's entityKey plus the schema it conforms to (schemaKey / schemaVersion).
- entityKey
  Type: string
  required
  
  Entity key as supplied at workflow create time.
- schemaKey
  Type: string
  
  Key of the schema this entity conforms to.
- schemaVersion
  Type: string
  
  Pinned semver of the schema this entity conforms to.
name
Type: string

Human-readable name for the workflow. Defaults are derived at create time (see POST /workflows).
voidedAt
Type: stringFormat: date-time

When the workflow was voided. Absent for non-voided workflows.
voidReason
Type: string

Reason supplied at void time. Absent for non-voided workflows or when no reason was supplied.