Definitions

Retrieve a custom action definition

Changed on

Retrieve a custom workflow action definition by ID.

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

Request

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

Path parameters

appIdinteger required
definitionIdstring required

Query parameters

archivedboolean

Whether to return only results that have been archived.

Response

successful operation

actionUrlstring required
archivedAtinteger
idstring required
labelsobject required
objectTypesstring[] required
publishedboolean required
revisionIdstring required

Changes

    • info

      removed the ARRAY enum value from the ///// response property for the response status

    • info

      removed the ARRAY enum value from the ///// response property for the response status

    • info

      removed the ARRAY enum value from the ///// response property for the response status

    • info

      removed the ARRAY enum value from the ///// response property for the response status

    • info

      removed the ARRAY enum value from the ///// response property for the response status

    • info

      removed the ARRAY enum value from the ///// response property for the response status

    • info

      removed the BOOLEAN enum value from the ///// response property for the response status

    • info

      removed the BOOLEAN enum value from the ///// response property for the response status

    • info

      removed the BOOLEAN enum value from the ///// response property for the response status

    • info

      removed the BOOLEAN enum value from the ///// response property for the response status

    • info

      removed the BOOLEAN enum value from the ///// response property for the response status

    • info

      removed the BOOLEAN enum value from the ///// response property for the response status

    • info

      removed the DOUBLE enum value from the ///// response property for the response status

    • info

      removed the DOUBLE enum value from the ///// response property for the response status

    • info

      removed the DOUBLE enum value from the ///// response property for the response status

    • info

      removed the DOUBLE enum value from the ///// response property for the response status

    • info

      removed the DOUBLE enum value from the ///// response property for the response status

    • info

      removed the DOUBLE enum value from the ///// response property for the response status

    • info

      removed the INTEGER enum value from the ///// response property for the response status

    • info

      removed the INTEGER enum value from the ///// response property for the response status

    • info

      removed the INTEGER enum value from the ///// response property for the response status

    • info

      removed the INTEGER enum value from the ///// response property for the response status

    • info

      removed the INTEGER enum value from the ///// response property for the response status

    • info

      removed the INTEGER enum value from the ///// response property for the response status

    • info

      removed the LONG enum value from the ///// response property for the response status

    • info

      removed the LONG enum value from the ///// response property for the response status

    • info

      removed the LONG enum value from the ///// response property for the response status

    • info

      removed the LONG enum value from the ///// response property for the response status

    • info

      removed the LONG enum value from the ///// response property for the response status

    • info

      removed the LONG enum value from the ///// response property for the response status

    • info

      removed the OBJECT enum value from the ///// response property for the response status

    • info

      removed the OBJECT enum value from the ///// response property for the response status

    • info

      removed the OBJECT enum value from the ///// response property for the response status

    • info

      removed the OBJECT enum value from the ///// response property for the response status

    • info

      removed the OBJECT enum value from the ///// response property for the response status

    • info

      removed the OBJECT enum value from the ///// response property for the response status

    • info

      removed the STRING enum value from the ///// response property for the response status

    • info

      removed the STRING enum value from the ///// response property for the response status

    • info

      removed the STRING enum value from the ///// response property for the response status

    • info

      removed the STRING enum value from the ///// response property for the response status

    • info

      removed the STRING enum value from the ///// response property for the response status

    • info

      removed the STRING enum value from the ///// response property for the response status

    • info

      api operation id get-/automation/actions/2026-03/{appId}/{definitionId}_getById removed and replaced with get-/automation/actions/2026-03/{appId}/{definitionId}

Some revisions have not been checked yet.