WorkflowListItem

Summary of a workflow as returned in list responses. Carries identity, current status, source reference, audit fields, participants, a slim envelope summary, and step-progress counters. Fetch the full workflow via GET /workflows/{id} for the complete workflow info.

createdAt
Type: stringFormat: date-time
required

When the workflow was created.
createdBy
Type: object
required

Actor who created the workflow.
- id
  Type: string
  required
  
  Stable ID for the actor (UUID for users; the API key's keyId for service accounts).
- type
  Type: stringenum
  required
  values
  user
  api_key
id
Type: string
required

Unique identifier of the workflow.
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 status of the workflow. completed, failed, declined, and voided are terminal.
values
- pending
- in_progress
- completed
- failed
- declined
- voided
completedAt
Type: stringFormat: date-time

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

When a participant declined the workflow, transitioning it to declined status. 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

Description of the workflow.
envelopes
Type: array object[]

Slim envelope summary — just key and current status. Document and rendered-file detail is omitted from list responses; fetch the full workflow via GET /workflows/{id} for that.
- key
  Type: string
  required
  
  Envelope key, matching the envelope key declared on the workflow's blueprint.
- status
  Type: stringenum
  required
  
  Current envelope status.
  
  values
  pending
  in_progress
  completed
  voided
  failed
idempotencyKey
Type: string

Caller-supplied Idempotency-Key header value from POST /workflows, if one was provided. Useful for looking up a workflow by the key the caller used to create it (e.g., after a retry where the original workflowId wasn't persisted).
inputEntities
Type: array object[]

Lightweight summary of the entities supplied at workflow create time — entityKey plus the pinned schema (schemaKey + schemaVersion) each conforms to.

schemaKey and schemaVersion are populated for workflows created from a stored blueprint or from a library listing. For listing-sourced workflows, the values reference schemas in the listing publisher's namespace — they're not resolvable in your namespace via GET /schemas/{key}. For inline workflows, they may be omitted when the entity's schema was supplied inline rather than referenced by key.
- entityKey
  Type: string
  required
  
  Local key the workflow uses to reference this entity (matches the inputs[].key declared on the workflow's blueprint).
- schemaKey
  Type: string
  
  Resource key of the schema this entity's data conforms to.
- schemaVersion
  Type: string
  
  Specific schema version pinned to this entity (semver — e.g. 1.0.0). Together with schemaKey, uniquely identifies the stored schema the entity was validated against.
name
Type: string

Human-readable name for the workflow.
participants
Type: array object[] · ParticipantInfo[]

Concrete people assigned to participant slots on the workflow.
- key
  Type: string
  required
- email
  Type: string
- name
  Type: string
progress
Type: object

Step-tree progress counters, derived from the workflow's step runs. Envelope progress can be derived from the envelopes[].status field above.
- completedSteps
  Type: integer
  
  Number of steps that have reached completed or skipped status.
- totalSteps
  Type: integer
  
  Total number of steps in the workflow's step tree.
voidedAt
Type: stringFormat: date-time

When the workflow was voided via POST /workflows/{id}/void. Absent for workflows that haven't been voided.
voidReason
Type: string

Reason supplied at void time (POST /workflows/{id}/void request body's reason). Absent for workflows that haven't been voided, or when no reason was supplied.