Get workflow

Last updated June 17, 2020

GET /automation/v3/workflows/:workflowId

Note: The Workflows API currently only supports contact-based workflows.

Method Details

HTTP Methods:


Response Format:


Requires Authentication?


Rate Limited?






Returns metadata for a workflow, including the starting conditions and workflow steps. Workflow IDs can be found by using the get all workflows endpoint.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
Workflow ID Used in the request URL The ID of the workflow you wish to see metadata for.
Optional Parameters How to use Description
errors=true Used in the request URL includes coded workflow validation errors and warnings at various points throughout the workflow structure.
stats=true Used in the request URL includes the number of contacts enrolled, active, completed and that have joined the goal list within the metaData object; also includes the CTR of email actions in the workflow within those action objects as a "clickThroughRatio” field

Example URL to GET: