Get workflow instances | Docusign

{
  "instances": [
    {
      "workflow_instance_id": "0ca3ef23-eb34-45d7-98cf-fb31a8b147a7",
      "workflow_definition_id": "c6f818da-4b15-4ac7-81b6-e70ea5e2f097",
      "account_id": "84f8efc2-cb73-4215-b218-f2abfda4a27b",
      "trigger_type": "Url",
      "progress": {
        "total_steps": 3,
        "completed_steps": 3,
        "current_completed_step_name": "Show a Confirmation Screen"
      },
      "version_details": {
        "deploy_version": "3.0.0",
        "deploy_workflow_definition_metadata_id": "6861b5003a05d457ba7f7dee"
      },
      "instance_state": "Completed",
      "last_activity_date": "2026-03-19T20:45:12.285Z",
      "expire_date": "2026-06-16T20:40:54.008Z",
      "start_date": "2026-03-18T20:40:44.933Z",
      "creator_id": "7d445df2-4110-4470-a8df-1553fe530c72",
      "started_by": {
        "started_by_name": "Maestro Backend",
        "started_by_id": "7d445df2-4110-4470-a8df-1553fe530c72",
        "started_by_type": "OnBehalfOf"
      },
      "instance_name": "2026-03-18T20:40:43.817Z_0ca3ef23-eb34-45d7-98cf-fb31a8b147a7",
      "end_date": "2026-03-19T20:45:12.285Z",
      "tags": null
    },
    {
      "workflow_instance_id": "af2637b0-d5f2-4644-8dbd-1d9f7b42b77c",
      "workflow_definition_id": "c6f818da-4b15-4ac7-81b6-e70ea5e2f097",
      "account_id": "84f8efc2-cb73-4215-b218-f2abfda4a27b",
      "trigger_type": "Url",
      "progress": {
        "total_steps": 3,
        "completed_steps": 3,
        "current_completed_step_name": "Show a Confirmation Screen"
      },
      "version_details": {
        "deploy_version": "3.0.0",
        "deploy_workflow_definition_metadata_id": "6861b5003a05d457ba7f7dee"
      },
      "instance_state": "Completed",
      "last_activity_date": "2026-03-19T20:39:21.126Z",
      "expire_date": "2026-06-16T20:35:50.387Z",
      "start_date": "2026-03-18T20:35:31.707Z",
      "creator_id": "7d445df2-4110-4470-a8df-1553fe530c72",
      "started_by": {
        "started_by_name": "Maestro Backend",
        "started_by_id": "7d445df2-4110-4470-a8df-1553fe530c72",
        "started_by_type": "OnBehalfOf"
      },
      "instance_name": "2026-03-18T20:35:30.483Z_af2637b0-d5f2-4644-8dbd-1d9f7b42b77c",
      "end_date": "2026-03-19T20:39:21.126Z",
      "tags": null
    }
  ],
  "total_set_size": 2,
  "result_set_size": 2,
  "ctoken": null
}

Returns a paginated list of workflow instances across all workflow definitions for the specified account.

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.

Query parameters

started_by_idstringOptional

Filter instances by the user who started them. Non-admin users without MANAGE permission will always be restricted to their own userId, and any attempt to filter by another userId will result in a 403 Forbidden response.

workflow_definition_idlist of stringsOptional

Filter instances by one or more workflow definition IDs. Repeat the parameter for multiple values.

statusenumOptional

Filter instances by status.

ctokenstringOptional

Opaque token returned from a previous response to retrieve the next page of results. Omit to retrieve the first page.

page_sizeintegerOptionalDefaults to 10

Number of items per page.

Response

A paginated list of workflow instances for the specified account.

instanceslist of objects

total_set_sizeinteger

Approximate total number of matching workflow instances across all pages. This value is evaluated once at the start of the query and cached for subsequent pages, so it may not reflect additions or deletions that occur after the initial request.

result_set_sizeinteger

Number of items returned in the current page.

ctokenstring or null

Opaque token to retrieve the next page of results. Null when there are no more pages. Pass this value as the ctoken query parameter in the next request.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error