Skip to navigation
API referenceObjectsWorkflows

Get workflow instance

View as Markdown

Get a workflow instance

Developing with the CLM API is only available for CLM customers with a production account. To purchase a plan to gain access to the CLM API, contact Docusign Sales.

Authentication

AuthorizationBearer

Docusign OAuth 2.0 access token, sent as Authorization: Bearer <token>.

Path parameters

instanceIdstringRequiredformat: "uuid"
ID of workflow instance.
accountIdstringRequiredformat: "uuid"
The ID of the Docusign account.

Response

OK
NamestringOptional
The name of the workflow as given in the workflow designer. Required when starting a new workflow
StartDatedatetimeOptional
Date and time the workflow was started
EndDatedatetimeOptional
Date and time the workflow ended. Null if the workflow has not yet ended
StatusstringOptional

Status of the workflow. Possible values include: Execution Pending, Executing, Waiting, Completed, Paused, Failed, Aborted

InfostringOptional
Additional information associated with the workflow
ParamsstringOptional
XML data used when starting the workflow. Only used when starting a new workflow
HrefstringOptional
Uri where the object can be retrieved.
WorkflowDocumentsobjectOptional
Documents passed when starting a workflow. Only used when starting a new workflow