Zum Hauptinhalt springen
GET
/
automation
/
v4
/
flows
/
{flowId}
Einen Workflow abrufen
curl --request GET \
  --url https://api.hubapi.com/automation/v4/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": [
            {
              "filterType": "PROPERTY",
              "operation": "<unknown>",
              "property": "<string>"
            }
          ]
        }
      ],
      "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"
  }
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Professional
Sales HubSales Hub -Professional
Service HubService Hub -Professional
Content HubContent Hub -Professional

Autorisierungen

Authorization
string
header
erforderlich

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

Pfadparameter

flowId
string
erforderlich

Die eindeutige ID für den abzurufenden Automatisierungsflow.

Antwort

successful operation

type
enum<string>
Standard:CONTACT_FLOW
erforderlich
Verfügbare Optionen:
CONTACT_FLOW,
PLATFORM_FLOW
id
string
erforderlich
isEnabled
boolean
erforderlich
flowType
enum<string>
erforderlich
Verfügbare Optionen:
WORKFLOW,
ACTION_SET,
UNKNOWN
revisionId
string
erforderlich
createdAt
string<date-time>
erforderlich
updatedAt
string<date-time>
erforderlich
nextAvailableActionId
string
erforderlich
actions
(STATIC_BRANCH · object | LIST_BRANCH · object | AB_TEST_BRANCH · object | CUSTOM_CODE · object | WEBHOOK · object | SINGLE_CONNECTION · object)[]
erforderlich
timeWindows
object[]
erforderlich
blockedDates
object[]
erforderlich
customProperties
object
erforderlich
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)[]
erforderlich
crmObjectCreationStatus
enum<string>
erforderlich
Verfügbare Optionen:
PENDING,
COMPLETE
suppressionListIds
integer<int32>[]
erforderlich
canEnrollFromSalesforce
boolean
erforderlich
objectTypeId
string
erforderlich
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 March 24, 2026