Skip to main content
GET
/
automation
/
v3
/
workflows
/
{workflowId}
Get a workflow
curl --request GET \
  --url https://api.hubapi.com/automation/v3/workflows/{workflowId}
{
  "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
    }
  }
}

Required Scopes

This API requires one of the following scopes:
  • automation

Path Parameters

workflowId
integer
required

ID of the workflow

Query Parameters

errors
boolean

Include validation errors and warnings

stats
boolean

Include workflow statistics

Response

Workflow metadata

Simplified workflow schema

id
integer
name
string
type
string
enabled
boolean