curl --request POST \
--url https://api.hubapi.com/automation/v4/flows/batch/read \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"inputs": [
{
"type": "FLOW_ID",
"flowId": "<string>"
}
]
}'
{
"completedAt": "2023-11-07T05:31:56Z",
"requestedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"links": {},
"results": [
{
"type": "CONTACT_FLOW",
"id": "<string>",
"isEnabled": true,
"flowType": "WORKFLOW",
"revisionId": "<string>",
"name": "<string>",
"description": "<string>",
"uuid": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"startActionId": "<string>",
"nextAvailableActionId": "<string>",
"actions": [
{
"staticBranches": [
{}
],
"defaultBranchName": "Other",
"defaultBranch": {
"nextActionId": "<any>",
"edgeType": "<any>"
},
"inputValue": "{ \"type\": \"STATIC_VALUE\", \"staticValue\": \"test_value\" }",
"actionId": "1",
"type": "STATIC_BRANCH"
}
],
"enrollmentCriteria": {
"listFilterBranch": {
"filterBranchType": "OR",
"filterBranches": [
"<any>"
],
"filterBranchOperator": "<string>",
"filters": [
"<any>"
]
},
"reEnrollmentTriggersFilterBranches": [
{
"filterBranchType": "<any>",
"filterBranches": "<any>",
"filterBranchOperator": "<any>",
"filters": "<any>"
}
],
"unEnrollObjectsNotMeetingCriteria": false,
"shouldReEnroll": false,
"type": "\"LIST_BASED\""
},
"enrollmentSchedule": {
"type": "DAILY",
"timeOfDay": {
"hour": 123,
"minute": 123
}
},
"timeWindows": [
{
"startTime": {
"hour": 123,
"minute": 123
},
"endTime": {
"hour": 123,
"minute": 123
},
"day": "MONDAY"
}
],
"blockedDates": [
{
"month": "JANUARY",
"year": 123,
"dayOfMonth": 123
}
],
"customProperties": {},
"dataSources": [
{
"objectTypeId": "<string>",
"name": "<string>",
"associationTypeId": 123,
"associationCategory": "HUBSPOT_DEFINED",
"sortBy": {
"property": "<string>",
"missing": "<string>",
"order": "ASC"
},
"type": "ASSOCIATION"
}
],
"crmObjectCreationStatus": "PENDING",
"suppressionListIds": [
123
],
"goalFilterBranch": {
"filterBranchType": "OR",
"filterBranches": [
"<any>"
],
"filterBranchOperator": "<string>",
"filters": [
"<any>"
]
},
"canEnrollFromSalesforce": true,
"eventAnchor": {
"type": "CONTACT_PROPERTY_ANCHOR",
"contactProperty": "example_date_property"
},
"unEnrollmentSetting": {
"flowIds": [
"<string>"
],
"type": "ALL"
},
"objectTypeId": "<string>"
}
],
"status": "PENDING"
}
Retrieve a batch of workflows by ID.
curl --request POST \
--url https://api.hubapi.com/automation/v4/flows/batch/read \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"inputs": [
{
"type": "FLOW_ID",
"flowId": "<string>"
}
]
}'
{
"completedAt": "2023-11-07T05:31:56Z",
"requestedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"links": {},
"results": [
{
"type": "CONTACT_FLOW",
"id": "<string>",
"isEnabled": true,
"flowType": "WORKFLOW",
"revisionId": "<string>",
"name": "<string>",
"description": "<string>",
"uuid": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"startActionId": "<string>",
"nextAvailableActionId": "<string>",
"actions": [
{
"staticBranches": [
{}
],
"defaultBranchName": "Other",
"defaultBranch": {
"nextActionId": "<any>",
"edgeType": "<any>"
},
"inputValue": "{ \"type\": \"STATIC_VALUE\", \"staticValue\": \"test_value\" }",
"actionId": "1",
"type": "STATIC_BRANCH"
}
],
"enrollmentCriteria": {
"listFilterBranch": {
"filterBranchType": "OR",
"filterBranches": [
"<any>"
],
"filterBranchOperator": "<string>",
"filters": [
"<any>"
]
},
"reEnrollmentTriggersFilterBranches": [
{
"filterBranchType": "<any>",
"filterBranches": "<any>",
"filterBranchOperator": "<any>",
"filters": "<any>"
}
],
"unEnrollObjectsNotMeetingCriteria": false,
"shouldReEnroll": false,
"type": "\"LIST_BASED\""
},
"enrollmentSchedule": {
"type": "DAILY",
"timeOfDay": {
"hour": 123,
"minute": 123
}
},
"timeWindows": [
{
"startTime": {
"hour": 123,
"minute": 123
},
"endTime": {
"hour": 123,
"minute": 123
},
"day": "MONDAY"
}
],
"blockedDates": [
{
"month": "JANUARY",
"year": 123,
"dayOfMonth": 123
}
],
"customProperties": {},
"dataSources": [
{
"objectTypeId": "<string>",
"name": "<string>",
"associationTypeId": 123,
"associationCategory": "HUBSPOT_DEFINED",
"sortBy": {
"property": "<string>",
"missing": "<string>",
"order": "ASC"
},
"type": "ASSOCIATION"
}
],
"crmObjectCreationStatus": "PENDING",
"suppressionListIds": [
123
],
"goalFilterBranch": {
"filterBranchType": "OR",
"filterBranches": [
"<any>"
],
"filterBranchOperator": "<string>",
"filters": [
"<any>"
]
},
"canEnrollFromSalesforce": true,
"eventAnchor": {
"type": "CONTACT_PROPERTY_ANCHOR",
"contactProperty": "example_date_property"
},
"unEnrollmentSetting": {
"flowIds": [
"<string>"
],
"type": "ALL"
},
"objectTypeId": "<string>"
}
],
"status": "PENDING"
}
automation
The access token received from the authorization server in the OAuth 2.0 flow.
successful operation
The response is of type object
.
Was this page helpful?