GET
/
automation
/
v4
/
flows
/
{flowId}
ワークフローの詳細を取得
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>",
  "name": "<string>",
  "description": "<string>",
  "uuid": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "startActionId": "<string>",
  "nextAvailableActionId": "<string>",
  "actions": [
    {
      "staticBranches": [
        {
          "branchValue": "some_value",
          "connection": {}
        }
      ],
      "defaultBranchName": "Other",
      "defaultBranch": {
        "nextActionId": "<string>",
        "edgeType": "<string>"
      },
      "inputValue": "{ \"type\": \"STATIC_VALUE\", \"staticValue\": \"test_value\" }",
      "actionId": "1",
      "type": "STATIC_BRANCH"
    }
  ],
  "enrollmentCriteria": {
    "listFilterBranch": {
      "filterBranchType": "OR",
      "filterBranches": [
        "<any>"
      ],
      "filterBranchOperator": "<string>",
      "filters": [
        "<any>"
      ]
    },
    "reEnrollmentTriggersFilterBranches": [
      {
        "filterBranchType": "OR",
        "filterBranches": [
          "<any>"
        ],
        "filterBranchOperator": "<string>",
        "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>"
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub無料ツール
Sales HubSales Hub無料ツール
Service HubService Hub無料ツール
Content HubContent Hub無料ツール

必須スコープ

この API には、次のいずれかのスコープが必要です。
  • automation

Authorizations

Authorization
string
header
required

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

Path Parameters

flowId
string
required

取得するワークフローのID。

Response

successful operation

The response is of type object.