Skip to main content
GET
/
automation
/
v4
/
actions
/
{appId}
/
{definitionId}
Recuperar una definición de acción personalizada
curl --request GET \
  --url https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}
{
  "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>"
    ]
  }
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubPro
Sales HubSales HubPro
Service HubService HubPro
Content HubContent HubGratuito

Authorizations

hapikey
string
query
required

Path Parameters

definitionId
string
required

El ID de la acción personalizada.

appId
integer
required

El ID de la aplicación.

Query Parameters

archived
boolean
default:false

Si se quieren devolver solo los resultados que se han archivado.

Response

successful operation

functions
object[]
required
actionUrl
string
required
published
boolean
required
labels
object
required
inputFields
object[]
required
revisionId
string
required
id
string
required
objectTypes
string[]
required
outputFields
object[]
archivedAt
integer
inputFieldDependencies
(SINGLE_FIELD · object | CONDITIONAL_SINGLE_FIELD · object)[]
  • SINGLE_FIELD
  • CONDITIONAL_SINGLE_FIELD
executionRules
object[]
objectRequestOptions
object