GET
/
automation
/
v4
/
actions
/
{appId}
/
{definitionId}
カスタムアクション定義を取得
curl --request GET \
  --url https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}
{
  "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>"
    ]
  }
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing HubProfessional
Sales HubSales HubProfessional
Service HubService HubProfessional
Content HubContent Hub無料ツール

Authorizations

hapikey
string
query
required

Path Parameters

definitionId
string
required

カスタムアクションのID。

appId
integer
required

アプリのID。

Query Parameters

archived
boolean
default:false

アーカイブ済みの結果のみを返すかどうか。

Response

successful operation

functions
object[]
required
actionUrl
string
required
published
boolean
required
labels
object
required
inputFields
object[]
required
revisionId
string
required
id
string
required
objectTypes
string[]
required
outputFields
object[]
archivedAt
integer
inputFieldDependencies
(SINGLE_FIELD · object | CONDITIONAL_SINGLE_FIELD · object)[]
executionRules
object[]
objectRequestOptions
object