GET
/
automation
/
v4
/
actions
/
{appId}
Retrieve custom action definitions
curl --request GET \
  --url https://api.hubapi.com/automation/v4/actions/{appId}
{
  "paging": {
    "next": {
      "link": "<string>",
      "after": "<string>"
    }
  },
  "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": true,
                "displayOrder": 123,
                "doubleData": 123,
                "description": "<string>",
                "readOnly": true,
                "label": "<string>",
                "value": "<string>"
              }
            ],
            "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": true,
                "displayOrder": 123,
                "doubleData": 123,
                "description": "<string>",
                "readOnly": true,
                "label": "<string>",
                "value": "<string>"
              }
            ],
            "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>"
        ]
      }
    }
  ]
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubProfessional
Sales HubSales HubProfessional
Service HubService HubProfessional
Content HubContent HubFree

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer
required

The ID of the app.

Query Parameters

​
limit
integer

The maximum number of results to display per page.

​
after
string

The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results.

​
archived
boolean
default:false

Whether to return only results that have been archived.

Response

200
application/json

successful operation

The response is of type object.