Definitions

Retrieve a custom action definition

Changed on

Retrieve a custom workflow action definition by ID.

get/automation/actions/2026-09/{appId}/{definitionId}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/automation/actions/2026-09/{appId}/{definitionId}
  • Auth
    API key in query parameter hapikey

Path parameters

appIdinteger required

The unique identifier of the app containing the extension definition.

definitionIdstring required

The unique identifier of the extension definition to retrieve.

Query parameters

archivedboolean

Whether to return only results that have been archived.

Response

successful operation

actionUrlstring required

The URL endpoint where the action is executed. It is a string.

archivedAtinteger

A Unix timestamp in milliseconds representing when the action was archived. It is an integer.

idstring required

The unique identifier for the action definition. It is a string.

labelsobject required

An object containing labels for the action, with each property being a PublicActionLabels object.

objectTypesstring[] required

An array of strings representing the types of objects associated with the action.

publishedboolean required

A boolean indicating whether the action is published and available for use.

revisionIdstring required

The unique identifier for the current revision of the action definition. It is a string.

Changes

  • 2026-095b95e5eb45d5Revision changes
    • warning

      added the new OBJECT_TYPE enum value to the ///// response property for the response status

    • warning

      added the new OBJECT_TYPE enum value to the /////// response property for the response status

  • 2026-095b95e5eb45d5Revision changes
    • warning

      added the new OBJECT_TYPE enum value to the ///// response property for the response status

    • warning

      added the new OBJECT_TYPE enum value to the /////// response property for the response status