Get workflow instances list | Docusign

{
  "data": [
    {
      "id": "fa4b77cb-dc69-4960-bd5c-9e6bf3c182e7",
      "name": "latency again",
      "workflow_status": "In Progress",
      "template_id": "25b96463-4aad-4cae-bbf9-15fbd5205b72",
      "account_id": "3b4453f5-869f-4c6a-8f1d-bcc260357144",
      "started_at": "2024-10-24T17:32:20.260Z",
      "started_by": "0ccdbb0b-a72e-452f-95f0-9f19654cb620",
      "started_by_name": "Jane Doe",
      "started_by_role": "Preparer",
      "ended_at": "2024-10-24T19:54:11.345Z",
      "expires_at": "2024-10-25T17:32:20.261Z",
      "last_modified_at": "2024-10-24T17:32:20.610Z",
      "canceled_at": "2024-10-24T19:54:11.345Z",
      "canceled_by": "",
      "total_steps": 3,
      "last_completed_step": 0,
      "last_completed_step_name": null,
      "tags": [],
      "metadata": {
        "workflow_created_by": "f6a8f4d2-b1b5-4fa4-b067-3de168907526",
        "workflow_version": "1.0.0",
        "workflow_metadata_id": "66df63a436871a9d22c63b9f"
      },
      "trigger_input": {}
    }
  ],
  "response_metadata": {
    "response_timestamp": "2024-10-17T14:30:00Z",
    "response_duration_ms": 100,
    "request_id": "3f7c9e4b-851c-4f9b-89e7-123456789abc"
  }
}

This operation retrieves a list of all available Workflow Builder workflow instances. It returns basic information about each workflow instance, including its unique identifier (id), name, status, timestamps, and additional metadata.

The response provides key details that help users understand what workflow instances are in progress or completed, and the relevant data for each. Each workflow instance entry also includes metadata, such as who started it, when it was last modified, and how many steps have been completed.

Use Cases:

Listing all available workflow instances for manual or automated review
Monitoring which workflow instances are currently running or have finished
Gathering basic metadata about workflow instances for auditing, logging, or reporting purposes

Key Features:

Comprehensive Instance Overview: Provides a full list of workflow instances, giving visibility into all ongoing and completed workflows within the Workflow Builder platform
Metadata for Tracking: Includes helpful metadata like creation time, last modification date, and user details to support audit trails
Scalable and Future-Proof: Designed to handle growing numbers of workflow instances as the platform scales

Authentication

AuthorizationBearer

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

accountIdstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"

The unique identifier of the account.

workflowIdstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"

A universally unique identifier (UUID) in standard 8-4-4-4-12 format.

Response

Successful response containing a list of workflow instances

datalist of objectsOptional

Array of workflow instances

response_metadataobjectOptional

Additional server-side metadata for a given response