サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Authorizations
Path Parameters
アプリのID。
Query Parameters
ページごとに表示する結果の最大数。
最後に正常に読み取られたリソースのページ操作カーソルトークンは、より多くの結果を含むページ付きレスポンスのpaging.next.after JSONプロパティーとして返されます。
アーカイブ済みの結果のみを返すかどうか。
curl --request GET \
--url https://api.hubapi.com/automation/v4/actions/{appId}
{
"paging": {
"next": {
"link": "",
"after": ""
}
},
"results": [
{
"functions": [
{
"functionType": "PRE_ACTION_EXECUTION",
"id": "<string>"
}
],
"actionUrl": "<string>",
"published": true,
"labels": {},
"inputFields": [
{
"isRequired": true,
"automationFieldType": "<string>",
"typeDefinition": {
"helpText": "<string>",
"referencedObjectType": "CONTACT",
"name": "<string>",
"options": [
{
"hidden": false,
"displayOrder": 123,
"doubleData": 123,
"description": "",
"readOnly": false,
"label": "",
"value": ""
}
],
"description": "<string>",
"externalOptionsReferenceType": "<string>",
"label": "<string>",
"type": "string",
"fieldType": "booleancheckbox",
"optionsUrl": "<string>",
"externalOptions": true
},
"supportedValueTypes": [
"STATIC_VALUE"
]
}
],
"outputFields": [
{
"typeDefinition": {
"helpText": "<string>",
"referencedObjectType": "CONTACT",
"name": "<string>",
"options": [
{
"hidden": false,
"displayOrder": 123,
"doubleData": 123,
"description": "",
"readOnly": false,
"label": "",
"value": ""
}
],
"description": "<string>",
"externalOptionsReferenceType": "<string>",
"label": "<string>",
"type": "string",
"fieldType": "booleancheckbox",
"optionsUrl": "<string>",
"externalOptions": true
}
}
],
"revisionId": "<string>",
"archivedAt": 123,
"inputFieldDependencies": [
{
"dependencyType": "SINGLE_FIELD",
"controllingFieldName": "<string>",
"dependentFieldNames": [
"<string>"
]
}
],
"executionRules": [
{
"labelName": "<string>",
"conditions": {}
}
],
"id": "<string>",
"objectTypes": [
"<string>"
],
"objectRequestOptions": {
"properties": [
"<string>"
]
}
}
]
}
アプリIDを基準にカスタム ワークフロー アクション定義を取得します。
curl --request GET \
--url https://api.hubapi.com/automation/v4/actions/{appId}
{
"paging": {
"next": {
"link": "",
"after": ""
}
},
"results": [
{
"functions": [
{
"functionType": "PRE_ACTION_EXECUTION",
"id": "<string>"
}
],
"actionUrl": "<string>",
"published": true,
"labels": {},
"inputFields": [
{
"isRequired": true,
"automationFieldType": "<string>",
"typeDefinition": {
"helpText": "<string>",
"referencedObjectType": "CONTACT",
"name": "<string>",
"options": [
{
"hidden": false,
"displayOrder": 123,
"doubleData": 123,
"description": "",
"readOnly": false,
"label": "",
"value": ""
}
],
"description": "<string>",
"externalOptionsReferenceType": "<string>",
"label": "<string>",
"type": "string",
"fieldType": "booleancheckbox",
"optionsUrl": "<string>",
"externalOptions": true
},
"supportedValueTypes": [
"STATIC_VALUE"
]
}
],
"outputFields": [
{
"typeDefinition": {
"helpText": "<string>",
"referencedObjectType": "CONTACT",
"name": "<string>",
"options": [
{
"hidden": false,
"displayOrder": 123,
"doubleData": 123,
"description": "",
"readOnly": false,
"label": "",
"value": ""
}
],
"description": "<string>",
"externalOptionsReferenceType": "<string>",
"label": "<string>",
"type": "string",
"fieldType": "booleancheckbox",
"optionsUrl": "<string>",
"externalOptions": true
}
}
],
"revisionId": "<string>",
"archivedAt": 123,
"inputFieldDependencies": [
{
"dependencyType": "SINGLE_FIELD",
"controllingFieldName": "<string>",
"dependentFieldNames": [
"<string>"
]
}
],
"executionRules": [
{
"labelName": "<string>",
"conditions": {}
}
],
"id": "<string>",
"objectTypes": [
"<string>"
],
"objectRequestOptions": {
"properties": [
"<string>"
]
}
}
]
}
アプリのID。
ページごとに表示する結果の最大数。
最後に正常に読み取られたリソースのページ操作カーソルトークンは、より多くの結果を含むページ付きレスポンスのpaging.next.after JSONプロパティーとして返されます。
アーカイブ済みの結果のみを返すかどうか。