Passer au contenu principal
GET
/
automation
/
v4
/
flows
/
{flowId}
Récupérer un workflow
curl --request GET \
  --url https://api.hubapi.com/automation/v4/flows/{flowId} \
  --header 'Authorization: Bearer <token>'
{
  "actions": [
    {
      "actionId": "<string>",
      "inputValue": {
        "actionId": "<string>",
        "dataKey": "<string>",
        "type": "FIELD_DATA"
      },
      "staticBranches": [
        {
          "branchValue": "<string>",
          "connection": {
            "nextActionId": "<string>"
          }
        }
      ],
      "type": "STATIC_BRANCH",
      "defaultBranch": {
        "nextActionId": "<string>"
      },
      "defaultBranchName": "<string>"
    }
  ],
  "blockedDates": [
    {
      "dayOfMonth": 123,
      "year": 123
    }
  ],
  "canEnrollFromSalesforce": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "customProperties": {},
  "dataSources": [
    {
      "associationTypeId": 123,
      "name": "<string>",
      "objectTypeId": "<string>",
      "type": "ASSOCIATION",
      "sortBy": {
        "property": "<string>",
        "missing": "<string>"
      }
    }
  ],
  "id": "<string>",
  "isEnabled": true,
  "nextAvailableActionId": "<string>",
  "objectTypeId": "<string>",
  "revisionId": "<string>",
  "suppressionListIds": [
    123
  ],
  "timeWindows": [
    {
      "endTime": {
        "hour": 123,
        "minute": 123
      },
      "startTime": {
        "hour": 123,
        "minute": 123
      }
    }
  ],
  "type": "CONTACT_FLOW",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<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"
  },
  "eventAnchor": {
    "contactProperty": "<string>",
    "type": "CONTACT_PROPERTY_ANCHOR"
  },
  "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>"
      }
    ]
  },
  "name": "<string>",
  "startActionId": "<string>",
  "unEnrollmentSetting": {
    "flowIds": [
      "<string>"
    ]
  },
  "uuid": "<string>"
}

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

Réponse

successful operation

actions
(STATIC_BRANCH · object | LIST_BRANCH · object | AB_TEST_BRANCH · object | CUSTOM_CODE · object | WEBHOOK · object | SINGLE_CONNECTION · object)[]
requis
blockedDates
object[]
requis
canEnrollFromSalesforce
boolean
requis
createdAt
string<date-time>
requis
crmObjectCreationStatus
enum<string>
requis
Options disponibles:
COMPLETE,
PENDING
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
flowType
enum<string>
requis
Options disponibles:
ACTION_SET,
UNKNOWN,
WORKFLOW
id
string
requis
isEnabled
boolean
requis
nextAvailableActionId
string
requis
objectTypeId
string
requis
revisionId
string
requis
suppressionListIds
integer<int32>[]
requis
timeWindows
object[]
requis
type
enum<string>
défaut:CONTACT_FLOW
requis
Options disponibles:
CONTACT_FLOW
updatedAt
string<date-time>
requis
description
string
enrollmentCriteria
LIST_BASED · object
enrollmentSchedule
DAILY · object
eventAnchor
CONTACT_PROPERTY_ANCHOR · object
goalFilterBranch
OR · object
name
string
startActionId
string
unEnrollmentSetting
object
uuid
string
Dernière modification le 13 avril 2026