Get workflow instance
This operation retrieves a single Workflow Builder workflow instance by its unique identifier (id).
It returns the primary details of the workflow instance, including its name, status,
starting information, and other metadata.
The response provides key details that help users understand the current state of the workflow instance, when it was started, and who initiated it. Additional metadata is included to support auditing and reporting within the system.
Use Cases:
- Getting the details of a specific workflow instance for further processing or review
- Monitoring the status of a running workflow instance to determine completion or cancellation
- Accessing metadata for auditing, logging, or reporting on a single workflow instance
Key Features:
- Single Workflow Instance: Provides direct access to a specific workflow instance by
id - Detailed Status Information: Includes the workflow’s start and end times, status, and other lifecycle timestamps
- Metadata for Tracking: Useful metadata like who initiated the workflow (
started_by) and versioning details - Future-Proof: Designed to be extensible if additional fields or nested information are required over time
Authentication
OAuth2 authentication.
- Demo:
- authorizationUrl: https://account-d.docusign.com/oauth/auth
- tokenUrl: https://account-d.docusign.com/oauth/token
- Production:
- authorizationUrl: https://account.docusign.com/oauth/auth
- tokenUrl: https://account.docusign.com/oauth/token
Path parameters
A universally unique identifier (UUID) in standard 8-4-4-4-12 format.
Response
Human-readable name for the workflow instance
Current status of the workflow (e.g. In Progress, Completed, Canceled)
Role of the user who started this workflow (e.g. Preparer)
Date and time when the workflow was canceled (if applicable)
User or system identifier that canceled this workflow (if applicable)
A key-value pair where the key is the field_name defined in the trigger_input_schema of the workflow definition,
and the value is the actual input data. Supported types include string, number, boolean, object, or array.