Get workflow

Last updated February 16, 2022

GET /automation/v3/workflows/:workflowId

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

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

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

When using this API, only certain actions are supported. If unsupported actions are included, the action type returned will be UNSUPPORTED_ACTION. For a list of supported actions, refer to the Supported Actions table. 

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:  https://api.hubapi.com/automation/v3/workflows/10900?hapikey=demo

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: https://api.hubapi.com/automation/v3/workflows/10900?hapikey=demo Example Response: { "name": "Testing 123", "actions": [ ], "id": 10900, "type": "DRIP_DELAY", "enabled": false, "portalId": 62515, "internal": false, "onlyExecOnBizDays": true, "nurtureTimeRange": { "enabled": false, "startHour": 9, "stopHour": 10 }, "listening": false, "insertedAt": 1348564640837, "updatedAt": 1467737836223, "allowContactToTriggerMultipleTimes": false, "unenrollmentSetting": { "type": "NONE", "excludedWorkflows": [ ] }, "recurringSetting": { "type": "NONE" }, "enrollOnCriteriaUpdate": false, "onlyEnrollsManually": false, "goalCriteria": [ [ { "propertyObjectType": "COMPANY", "filterFamily": "CompanyPropertyValue", "withinTimeMode": "PAST", "property": "active__c", "value": "Yes", "type": "enumeration", "operator": "SET_ANY" } ] ], "reEnrollmentTriggerSets": [ ], "suppressionListIds": [ ], "lastUpdatedBy": "test@hubspot.com", "segmentCriteria": [ ], "metaData": { "triggeredByWorkflowIds": [ ], "succeededListId": 183192, "contactListIds": { "active": 68737, "completed": 301, "succeeded": 183192, "enrolled": 300 } } }