Skip to main content
GET
/
automation
/
v4
/
actions
/
{appId}
Retrieve custom action definitions
curl --request GET \
  --url https://api.hubapi.com/automation/v4/actions/{appId}
{
  "paging": {
    "next": {
      "after": "<string>",
      "link": "<string>"
    }
  },
  "results": [
    {
      "actionUrl": "<string>",
      "archivedAt": 123,
      "executionRules": [
        {
          "conditions": {},
          "labelName": "<string>"
        }
      ],
      "functions": [
        {
          "functionType": "POST_ACTION_EXECUTION",
          "id": "<string>"
        }
      ],
      "id": "<string>",
      "inputFieldDependencies": [
        {
          "controllingFieldName": "<string>",
          "dependencyType": "SINGLE_FIELD",
          "dependentFieldNames": [
            "<string>"
          ]
        }
      ],
      "inputFields": [
        {
          "automationFieldType": "<string>",
          "isRequired": true,
          "supportedValueTypes": [
            "STATIC_VALUE"
          ],
          "typeDefinition": {
            "description": "<string>",
            "externalOptions": true,
            "externalOptionsReferenceType": "<string>",
            "fieldType": "booleancheckbox",
            "helpText": "<string>",
            "label": "<string>",
            "name": "<string>",
            "options": [
              {
                "description": "<string>",
                "displayOrder": 123,
                "doubleData": 123,
                "hidden": true,
                "label": "<string>",
                "readOnly": true,
                "value": "<string>"
              }
            ],
            "optionsUrl": "<string>",
            "referencedObjectType": "ABANDONED_CART",
            "type": "bool"
          }
        }
      ],
      "labels": {},
      "objectRequestOptions": {
        "properties": [
          "<string>"
        ]
      },
      "objectTypes": [
        "<string>"
      ],
      "outputFields": [
        {
          "typeDefinition": {
            "description": "<string>",
            "externalOptions": true,
            "externalOptionsReferenceType": "<string>",
            "fieldType": "booleancheckbox",
            "helpText": "<string>",
            "label": "<string>",
            "name": "<string>",
            "options": [
              {
                "description": "<string>",
                "displayOrder": 123,
                "doubleData": 123,
                "hidden": true,
                "label": "<string>",
                "readOnly": true,
                "value": "<string>"
              }
            ],
            "optionsUrl": "<string>",
            "referencedObjectType": "ABANDONED_CART",
            "type": "bool"
          }
        }
      ],
      "published": true,
      "revisionId": "<string>"
    }
  ]
}

Supported products

Requires one of the following products or higher.
Marketing HubMarketing Hub -Professional
Sales HubSales Hub -Professional
Service HubService Hub -Professional
Content HubContent Hub -Free

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer
required

The ID of the app.

Query Parameters

​
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.

​
limit
integer

The maximum number of results to display per page.

Response

successful operation

​
results
object[]
required
​
paging
object