There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Get workflows

Last updated May 15, 2023

GET /automation/v3/workflows

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

Required Scope:

automation

Get a list of workflows for a HubSpot portal. This endpoint is particularly useful if you are looking for a particular workflow and need to look it up by an Id. The endpoint only returns metadata for each workflow.

The endpoint can also be used when syncing to a CRM system to display a list of workflows a salesperson can enroll a prospect into.

 

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.

Example URL to GET:  https://api.hubapi.com/automation/v3/workflows/

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/ Example response: { "workflows": [ { "name": "Testing 123", "id": 10900, "type": "DRIP_DELAY", "enabled": false, "insertedAt": 1348564640837, "updatedAt": 1467737836223, "personaTagIds": [ ], "contactListIds": { "enrolled": 300, "active": 68737, "steps": [ ] } }, { "name": "Test 2", "id": 12707, "enabled": false, "insertedAt": 1349673659792, "updatedAt": 1349673659792, "personaTagIds": [ ], "contactListIds": { "enrolled": 309, "active": 68738, "steps": [ ] } }, { "name": "Example Workflow", "id": 23505, "enabled": false, "insertedAt": 1353448650631, "updatedAt": 1353448650631, "personaTagIds": [ ], "contactListIds": { "enrolled": 318, "active": 68740, "steps": [ ] } }, // ... ] }