Get workflow definition for envelope

GET

/v2.1/accounts/:accountId/envelopes/:envelopeId/workflow

GET

/restapi/v2.1/accounts/:accountId/envelopes/:envelopeId/workflow

curl https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/envelopes/ENVELOPE_ID/workflow \
     -H "Authorization: Bearer <apiKey>"

{
  "currentWorkflowStepId": "sample string 1",
  "overwriteUpdateMode": "sample string 2",
  "resumeDate": "sample string 3",
  "scheduledSending": {
    "bulkListId": "sample string 1",
    "resumeDate": "sample string 2",
    "rules": [
      {
        "delay": "sample string 1",
        "resumeDate": "sample string 2"
      }
    ],
    "status": "sample string 3"
  },
  "workflowStatus": "sample string 4",
  "workflowSteps": [
    {
      "action": "sample string 1",
      "completedDate": "sample string 2",
      "delayedRouting": {
        "resumeDate": "sample string 1",
        "rules": [
          {}
        ],
        "status": "sample string 2"
      },
      "itemId": "sample string 3",
      "recipientRouting": {
        "rules": {
          "conditionalRecipients": [
            {}
          ]
        }
      },
      "status": "sample string 4",
      "triggeredDate": "sample string 5",
      "triggerOnItem": "sample string 6",
      "workflowStepId": "sample string 7"
    }
  ]
}

Returns the workflow definition for the envelope specified by envelopeId. If the envelope does not have a workflow object, this method returns a 404.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

The external account number (int) or account ID Guid.

envelopeIdstringRequired

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Response

Successful response.

currentWorkflowStepIdstringOptional

The workflowStepId of the current step. This is not an index into the workflowSteps array in this object. See the workflowStep object.

overwriteUpdateModestringOptional

resumeDatestringOptional

The ISO 8601 timestamp of when the envelope is scheduled to be sent, if applicable. Its value is the maximum of the resumeDate property on scheduledSending and the resumeDate property on the current workflowStep.

This property is read-only.

scheduledSendingobjectOptional

A complex element that specifies the scheduled sending settings for the envelope.

workflowStatusstringOptional

The status of the workflow:

paused if the workflow is paused
in_progress if the workflow is in progress

workflowStepslist of objectsOptional

An array of workflow steps.

Errors

400

Bad Request Error