Maestro API
API for triggering and managing automated workflows
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
API for triggering and managing automated workflows
Endpoints 8
WorkflowInstanceManagement
- GETRetrieve All Workflow Instances
/v1/accounts/:accountId/workflows/:workflowId/instancesThis operation retrieves a list of all available Maestro workflow instances. It returns basic information about each workflow instance, including its unique… - GETRetrieve a Workflow Instance
/v1/accounts/:accountId/workflows/:workflowId/instances/:instanceIdThis operation retrieves a single Maestro workflow instance by its unique identifier (id). It returns the primary details of the workflow instance, including… - POSTCancel a Running Workflow Instance
/v1/accounts/:accountId/workflows/:workflowId/instances/:instanceId/actions/cancelThis operation cancels a running Maestro workflow instance by its unique identifier (instanceId). Once canceled, the workflow instance will no longer continue…
Workflows
- GETRetrieve a list of available Maestro workflows
/v1/accounts/:accountId/workflows?status=activeThis operation retrieves a list of all available Maestro workflows. It returns basic information about each workflow, including its unique identifier (id),… - GETRetrieve trigger requirements for a specific Maestro workflow
/v1/accounts/:accountId/workflows/:workflowId/trigger-requirementsThis operation retrieves the configuration and input requirements necessary to trigger a specific Maestro workflow. It provides detailed information about the… - POSTTrigger a new instance of a Maestro workflow
/v1/accounts/:accountId/workflows/:workflowId/actions/triggerThis operation triggers a new instance of a specified Maestro workflow. When invoked, the workflow is started based on the provided input data, and the… - POSTPause an Active Workflow
/v1/accounts/:accountId/workflows/:workflowId/actions/pauseThis operation pauses new workflow instances from being created. Any running workflows instances will be unaffected. Required scopes: signature, aow_manage - POSTResume a Paused Workflow
/v1/accounts/:accountId/workflows/:workflowId/actions/resumeThis operation enables new workflow instances to be created. Required scopes: signature, aow_manage
API details
- Base URL
https://api.docusign.comhttps://api-d.docusign.com- Authentication
- OAuth 2.0 (authorization code flow) with 3 scopes
- Operations
- 8 operations on 8 pathsGET 4POST 4
- Main resources
- Workflows 5WorkflowInstanceManagement 3
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1.0.7 - Links
- OpenAPI document · Terms of service · Support
How to test the Maestro API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Maestro API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Retrieve All Workflow Instances” (GET /v1/accounts/:accountId/workflows/:workflowId/instances), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Maestro API?
API for triggering and managing automated workflows It is listed under Other and has 8 endpoints.
Who publishes the Maestro API?
It is listed from DocuSign's public API description (an OpenAPI document), not published by DocuSign on Swastik Codes. Anyone who controls docusign.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Maestro API?
Its description lists 2 base URLs: https://api.docusign.com, https://api-d.docusign.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Maestro API?
With OAuth 2.0 (authorization code flow) with 3 scopes.
How many endpoints does the Maestro API have?
8 operations on 8 paths (4 GET, 4 POST). The largest groups are Workflows, WorkflowInstanceManagement.
Is forking the Maestro API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.