Passer au contenu principal
GET
/
automation
/
2026-09-beta
/
flows
/
{flowId}
Retrieve workflow
curl --request GET \
  --url https://api.hubapi.com/automation/2026-09-beta/flows/{flowId} \
  --header 'Authorization: Bearer <token>'
{
  "type": "CONTACT_FLOW",
  "id": "<string>",
  "isEnabled": true,
  "flowType": "WORKFLOW",
  "revisionId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "nextAvailableActionId": "<string>",
  "actions": [
    {
      "actionId": "<string>",
      "inputValue": {
        "actionId": "<string>",
        "dataKey": "<string>",
        "type": "FIELD_DATA"
      },
      "staticBranches": [
        {
          "branchValue": "<string>",
          "connection": {
            "edgeType": "GOTO",
            "nextActionId": "<string>"
          }
        }
      ],
      "type": "STATIC_BRANCH",
      "defaultBranch": {
        "edgeType": "GOTO",
        "nextActionId": "<string>"
      },
      "defaultBranchName": "<string>"
    }
  ],
  "timeWindows": [
    {
      "day": "FRIDAY",
      "endTime": {
        "hour": 123,
        "minute": 123
      },
      "startTime": {
        "hour": 123,
        "minute": 123
      }
    }
  ],
  "blockedDates": [
    {
      "dayOfMonth": 123,
      "month": "APRIL",
      "year": 123
    }
  ],
  "customProperties": {},
  "dataSources": [
    {
      "associationCategory": "HUBSPOT_DEFINED",
      "associationTypeId": 123,
      "name": "<string>",
      "objectTypeId": "<string>",
      "type": "ASSOCIATION",
      "sortBy": {
        "order": "ASC",
        "property": "<string>",
        "missing": "<string>"
      }
    }
  ],
  "crmObjectCreationStatus": "PENDING",
  "suppressionListIds": [
    123
  ],
  "canEnrollFromSalesforce": true,
  "objectTypeId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "uuid": "<string>",
  "startActionId": "<string>",
  "enrollmentCriteria": {
    "listFilterBranch": {
      "filterBranchOperator": "<string>",
      "filterBranchType": "OR",
      "filterBranches": [
        {
          "filterBranchOperator": "<string>",
          "filterBranchType": "AND",
          "filterBranches": "<array>",
          "filters": [
            "<unknown>"
          ]
        }
      ],
      "filters": [
        {
          "filterType": "PROPERTY",
          "operation": "<unknown>",
          "property": "<string>"
        }
      ]
    },
    "reEnrollmentTriggersFilterBranches": [
      {
        "filterBranchOperator": "<string>",
        "filterBranchType": "AND",
        "filterBranches": "<array>",
        "filters": [
          {
            "filterType": "PROPERTY",
            "operation": "<unknown>",
            "property": "<string>"
          }
        ]
      }
    ],
    "shouldReEnroll": true,
    "type": "LIST_BASED",
    "unEnrollObjectsNotMeetingCriteria": true
  },
  "enrollmentSchedule": {
    "timeOfDay": {
      "hour": 123,
      "minute": 123
    },
    "type": "DAILY"
  },
  "goalFilterBranch": {
    "filterBranchOperator": "<string>",
    "filterBranchType": "OR",
    "filterBranches": [
      {
        "filterBranchOperator": "<string>",
        "filterBranchType": "AND",
        "filterBranches": "<array>",
        "filters": [
          {
            "filterType": "PROPERTY",
            "operation": "<unknown>",
            "property": "<string>"
          }
        ]
      }
    ],
    "filters": [
      {
        "filterType": "PROPERTY",
        "operation": {
          "includeObjectsWithNoValueSet": true,
          "operationType": "BOOL",
          "operator": "<string>",
          "value": true
        },
        "property": "<string>"
      }
    ]
  },
  "eventAnchor": {
    "contactProperty": "<string>",
    "type": "CONTACT_PROPERTY_ANCHOR"
  },
  "unEnrollmentSetting": {
    "flowIds": [
      "<string>"
    ],
    "type": "ALL"
  }
}

Supported products

Autorisations

Authorization
string
header
requis

The access token received from the authorization server in the OAuth 2.0 flow.

Paramètres de chemin

flowId
string
requis

The unique identifier of the automation flow to retrieve.

Réponse

successful operation

type
enum<string>
défaut:CONTACT_FLOW
requis
Options disponibles:
CONTACT_FLOW,
PLATFORM_FLOW
id
string
requis
isEnabled
boolean
requis
flowType
enum<string>
requis
Options disponibles:
WORKFLOW,
ACTION_SET,
UNKNOWN
revisionId
string
requis
createdAt
string<date-time>
requis
updatedAt
string<date-time>
requis
nextAvailableActionId
string
requis
actions
(STATIC_BRANCH · object | LIST_BRANCH · object | AB_TEST_BRANCH · object | CUSTOM_CODE · object | WEBHOOK · object | SINGLE_CONNECTION · object)[]
requis
timeWindows
object[]
requis
blockedDates
object[]
requis
customProperties
object
requis
dataSources
(ASSOCIATION · object | ASSOCIATION_TIMESTAMP · object | STATIC_PROPERTY_FILTER · object | ENROLLED_RECORD_PROPERTY_FILTER · object | DATASET_FIELD_PROPERTY_FILTER · object | ENROLLED_ARGUMENT_PROPERTY_FILTER · object)[]
requis
crmObjectCreationStatus
enum<string>
requis
Options disponibles:
PENDING,
COMPLETE
suppressionListIds
integer<int32>[]
requis
canEnrollFromSalesforce
boolean
requis
objectTypeId
string
requis
name
string
description
string
uuid
string
startActionId
string
enrollmentCriteria
LIST_BASED · object
enrollmentSchedule
DAILY · object
goalFilterBranch
OR · object
eventAnchor
CONTACT_PROPERTY_ANCHOR · object
unEnrollmentSetting
object
Last modified on April 2, 2026