Passer au contenu principal
GET
/
automation
/
v4
/
actions
/
{appId}
/
{definitionId}
Récupérer une définition d'action personnalisée
curl --request GET \
  --url https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId} \
  --header 'Authorization: Bearer <token>'
{
  "actionUrl": "<string>",
  "functions": [
    {
      "id": "<string>"
    }
  ],
  "id": "<string>",
  "inputFields": [
    {
      "isRequired": true,
      "typeDefinition": {
        "name": "<string>",
        "options": [
          {
            "label": "<string>",
            "value": "<string>",
            "description": "<string>",
            "displayOrder": 123
          }
        ],
        "description": "<string>",
        "helpText": "<string>",
        "label": "<string>",
        "optionsUrl": "<string>",
        "referencedObjectType": "OWNER"
      },
      "supportedValueTypes": []
    }
  ],
  "labels": {},
  "objectTypes": [
    "<string>"
  ],
  "published": true,
  "revisionId": "<string>",
  "archivedAt": 123,
  "executionRules": [
    {
      "conditions": {},
      "labelName": "<string>"
    }
  ],
  "inputFieldDependencies": [
    {
      "controllingFieldName": "<string>",
      "dependencyType": "SINGLE_FIELD",
      "dependentFieldNames": [
        "<string>"
      ]
    }
  ],
  "objectRequestOptions": {
    "properties": [
      "<string>"
    ]
  },
  "outputFields": [
    {
      "typeDefinition": {
        "externalOptions": true,
        "name": "<string>",
        "options": [
          {
            "description": "<string>",
            "displayOrder": 123,
            "doubleData": 123,
            "hidden": true,
            "label": "<string>",
            "readOnly": true,
            "value": "<string>"
          }
        ],
        "schema": {
          "type": "INTEGER",
          "maximum": 123,
          "minimum": 123
        },
        "useChirp": true,
        "description": "<string>",
        "externalOptionsReferenceType": "<string>",
        "helpText": "<string>",
        "label": "<string>",
        "optionsUrl": "<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

appId
integer<int32>
requis

L'ID de l'application associée à la définition de l'action.

definitionId
string
requis

L'ID de la définition d'action à récupérer.

Paramètres de requête

archived
boolean
défaut:false

S'il faut renvoyer uniquement les résultats qui ont été archivés.

Réponse

successful operation

actionUrl
string
requis
functions
object[]
requis
id
string
requis
inputFields
object[]
requis
labels
object
requis
objectTypes
string[]
requis
published
boolean
requis
revisionId
string
requis
archivedAt
integer<int64>
executionRules
object[]
inputFieldDependencies
(SINGLE_FIELD · object | CONDITIONAL_SINGLE_FIELD · object)[]
objectRequestOptions
object
outputFields
object[]
Dernière modification le 13 avril 2026