ListWorkflowsResp

data
Type: array object[] · WorkflowListItem[]
required
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 Pattern: ^wf_[0-9a-z]{26}$
  required
  
  Unique identifier of the workflow. Prefixed lowercase ULID, e.g. wf_01jv8m7qfj6xj9gkz7a4s2h8e.
- 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.
- 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.
- name
  Type: string
  
  Human-readable name for the workflow.
- participants
  Type: array object[] · ParticipantInfo[]
  
  Concrete people assigned to participant slots on the workflow.
- 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.
- 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.
pagination
Type: object
required

Pagination metadata for list responses
- limit
  Type: integer
  required
  
  Maximum number of records per page
- offset
  Type: integer
  required
  
  Starting position in the result set
- total
  Type: integer
  required
  
  Total number of records available