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.

Current enrollment

Last updated May 22, 2023

GET /automation/v2/workflows/enrollments/contacts/:vid

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Get workflows a contact is currently enrolled in.

This is particularly useful for integrations that take contact data and display them in a different interface.

Required Parameters How to use Description
OAuth Access Token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
Contact VID Used in the request URL The VID of the contact in question.
Optional Parameters How to use Description
None None No optional parameters for this method.

Example URL:  https://api.hubapi.com/automation/v2/workflows/enrollments/contacts/2637

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/v2/workflows/enrollments/contacts/2637 Example JSON response: { "id": 406048, "portalId": 62515, "insertedAt": 1410279567999, "updatedAt": 1438211556173, "name": "Test", "triggers": [], "steps": [ { "emailActions": [ { "base": { "type": "EMAIL", "name": "Follow Up", "id": 668311 }, "emailCampaignId": 10329957, "emailContentId": 311698603, "emailCampaignGroupId": 0 } ], "id": 620991, "setContactPropertyActions": [], "salesForceActions": [], "listActions": [], "delayMillis": 172800000, "addSubtractPropertyActions": [], "copyPropertyActions": [], "webHookActions": [], "notificationActions": [], "smsNotificationActions": [], "anchorSetting": { "boundary": "AFTER", "execTimeOfDay": "12:00 PM" }, "listId": 129, "createSfdcTaskActions": [], "setCompanyPropertyActions": [], "dateStampPropertyActions": [], "campaignMembershipActions": [], "copyCompanyPropertyActions": [], "workflowEnrollmentActions": [], "incrementCompanyPropertyActions": [], "dealActions": [], "taskActions": [], "leadAssignmentActions": [], "addContactEnumOptionActions": [], "addCompanyEnumOptionActions": [] } ], "allowContactToTriggerMultipleTimes": false, "onlyExecOnBizDays": false, "enabled": true, "triggerSet": [], "nurtureTimeRange": { "enabled": false, "startHour": 9, "stopHour": 10 }, "legacyMigration": false, "legacyCampaignId": 0, "unenrollmentSetting": { "type": "NONE", "excludedWorkflows": [] }, "goalList": { "excludedListIds": [] }, "type": "DRIP_DELAY", "eventAnchor": { "staticDateAnchor": "", "contactPropertyAnchor": "" }, "contactLists": { "enrolledListId": 124, "completedListId": 126, "succeededListId": 127, "failedListId": 128, "activeListId": 125 }, "recurringSetting": { "type": "NONE" }, "isSegmentBased": true, "reEnrollmentTriggerSet": [], "goalCriteriaEnabled": true } { "id": 406048, "portalId": 311600, "insertedAt": 1410279567999, "updatedAt": 1438211556173, "name": "Test", "triggers": [], "steps": [ { "emailActions": [ { "base": { "type": "EMAIL", "name": "Follow Up", "id": 668311 }, "emailCampaignId": 10329957, "emailContentId": 311698603, "emailCampaignGroupId": 0 } ], "id": 620991, "setContactPropertyActions": [], "salesForceActions": [], "listActions": [], "delayMillis": 172800000, "addSubtractPropertyActions": [], "copyPropertyActions": [], "webHookActions": [], "notificationActions": [], "smsNotificationActions": [], "anchorSetting": { "boundary": "AFTER", "execTimeOfDay": "12:00 PM" }, "listId": 129, "createSfdcTaskActions": [], "setCompanyPropertyActions": [], "dateStampPropertyActions": [], "campaignMembershipActions": [], "copyCompanyPropertyActions": [], "workflowEnrollmentActions": [], "incrementCompanyPropertyActions": [], "dealActions": [], "taskActions": [], "leadAssignmentActions": [], "addContactEnumOptionActions": [], "addCompanyEnumOptionActions": [] } ], "allowContactToTriggerMultipleTimes": false, "onlyExecOnBizDays": false, "enabled": true, "triggerSet": [], "nurtureTimeRange": { "enabled": false, "startHour": 9, "stopHour": 10 }, "legacyMigration": false, "legacyCampaignId": 0, "unenrollmentSetting": { "type": "NONE", "excludedWorkflows": [] }, "goalList": { "excludedListIds": [] }, "type": "DRIP_DELAY", "eventAnchor": { "staticDateAnchor": "", "contactPropertyAnchor": "" }, "contactLists": { "enrolledListId": 124, "completedListId": 126, "succeededListId": 127, "failedListId": 128, "activeListId": 125 }, "recurringSetting": { "type": "NONE" }, "isSegmentBased": true, "reEnrollmentTriggerSet": [], "goalCriteriaEnabled": true }