GetWorkflowInfoResp

docusignEnvelopeId
Type: string
required

DocuSign envelope ID if integrated with DocuSign
entitySnapshots
Type: array object[]
required

Entity data snapshots used in the workflow
- createdAt
  Type: stringFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- data
  Type: object
  required
- entityKey
  Type: string
  required
- id
  Type: string
  required
- schemaId
  Type: string
  required
- schemaKey
  Type: string
  required
- updatedAt
  Type: stringFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- workflowId
  Type: string
  required
envelopes
Type: array object[]
required

E-signature envelopes in the workflow
- documents
  Type: array object[]
  required
- envelopeId
  Type: string
  required
  
  Unique envelope ID
- key
  Type: string
  required
  
  Envelope key
- resolutionMode
  Type: stringenum
  required
  values
  immediate
  just_in_time
- resolvedDocuments
  Type: array object[] · WorkflowDocumentInfo[]
  required
- status
  Type: stringenum
  required
  
  Envelope status
  
  values
  pending
  in_progress
  completed
  voided
  failed
- subject
  Type: string
  required
  
  Email template slug
- certificateFileId
  Type: string
- signedDocumentFileId
  Type: string
id
Type: string
required

Unique identifier of the workflow
organizationId
Type: string
required

Organization that owns this workflow
participants
Type: array object[] · ParticipantInfo[]
required

Workflow participants
- key
  Type: string
  required
- email
  Type: string
- name
  Type: string
rootStep
Type: object · WorkflowStep
required

The root step of the workflow execution tree with current status
- key
  Type: string
  required
  
  Step key
- type
  Type: stringenum
  required
  
  Type of step
  
  values
  group
  participant
- action
  Type: object
  
  Action details for participant steps
- children
  Type: array object[] · WorkflowStep[]
  
  Child steps (for group steps)
- completionRule
  Type: stringenum
  values
  all
  any
  quorum
- executionMode
  Type: stringenum
  values
  sequential
  parallel
- includeIf
  Type: string
- name
  Type: string
  
  Step display name
- onCompleteValidationExpression
  Type: string
- participantKey
  Type: string
- quorumCount
  Type: integer
  
  Integer numbers.
- status
  Type: stringenum
  
  Current execution status of this step
  
  values
  pending
  in_progress
  completed
  skipped
  failed
status
Type: stringenum
required

Overall workflow status
values
- pending
- in_progress
- completed
- failed
- declined
- voided
customFields
Type: array object[] · CustomFieldConfig[]
- key
  Type: string
  required
  
  Unique identifier for this custom field
- name
  Type: string
  required
  
  Human-readable name for this custom field
- value
  Type: string
  
  Value for the custom field (can be literal or JSONata expression)
description
Type: string

Description of the workflow
eventLog
Type: array object[]

Event log for the workflow
- details
  Type: object
- eventAt
  Type: stringFormat: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- eventType
  Type: string
- stepKey
  Type: string
name
Type: string

Human-readable name for the workflow
sourceBlueprint
Type: object

Blueprint this workflow was created from
- key
  Type: string
- version
  Type: string
updatedAt
Type: stringFormat: date-time

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z