> ## Documentation Index > Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve custom action definitions > Recupere definições de ações de fluxo de trabalho personalizadas por ID do aplicativo. > **Supported products** ## OpenAPI ````yaml specs/2026-03/automation-actions-v4-v2026-03.json GET /automation/actions/2026-03/{appId} openapi: 3.0.1 info: title: Automation Actions V4 description: Basepom for all HubSpot Projects version: 2026-03 x-hubspot-product-tier-requirements: marketing: PROFESSIONAL sales: PROFESSIONAL service: PROFESSIONAL cms: PROFESSIONAL commerce: PROFESSIONAL crmHub: PROFESSIONAL dataHub: PROFESSIONAL servers: - url: https://api.hubapi.com security: [] tags: - name: Callbacks - name: Definitions - name: Functions - name: Revisions paths: /automation/actions/2026-03/{appId}: get: tags: - Definitions summary: Recuperar definições de ação personalizadas description: >- Recupere definições de ações de fluxo de trabalho personalizadas por ID do aplicativo. operationId: get-/automation/actions/2026-03/{appId}_getPage parameters: - name: appId in: path description: >- O identificador exclusivo do aplicativo para o qual as definições de extensão serão recuperadas. required: true style: simple explode: false schema: type: integer format: int32 - name: after in: query description: >- O token do cursor de paginação do último recurso lido será retornado como a propriedade JSON `paging.next.after` de uma resposta paginada que contém mais resultados. required: false style: form explode: true schema: type: string - name: archived in: query description: Se apenas os resultados que foram arquivados devem ser retornados. required: false style: form explode: true schema: type: boolean default: false - name: limit in: query description: O número máximo de resultados a serem exibidos por página. required: false style: form explode: true schema: type: integer format: int32 responses: '200': description: successful operation content: application/json: schema: $ref: >- #/components/schemas/CollectionResponsePublicActionDefinitionForwardPaging default: $ref: '#/components/responses/Error' description: '' security: - developer_hapikey: [] components: schemas: CollectionResponsePublicActionDefinitionForwardPaging: required: - results type: object properties: paging: $ref: '#/components/schemas/ForwardPaging' results: type: array description: >- Uma matriz de definições de ação pública, cada uma representada por um objeto PublicActionDefinition. items: $ref: '#/components/schemas/PublicActionDefinition' ForwardPaging: type: object properties: next: $ref: '#/components/schemas/NextPage' description: >- Informações de paginação para paginação somente para frente. Contém a referência da próxima página quando há mais resultados disponíveis; é omitida ou fica vazia na última página. PublicActionDefinition: required: - actionUrl - functions - id - inputFields - labels - objectTypes - published - revisionId type: object properties: actionUrl: type: string description: O endpoint da URL onde a ação é executada. É uma string. archivedAt: type: integer description: >- Um carimbo de data/hora Unix em milissegundos que representa quando a ação foi arquivada. É um número inteiro. format: int64 executionRules: type: array description: >- Uma matriz de regras de tradução de execução para a ação, em que cada item é uma PublicExecutionTranslationRule. items: $ref: '#/components/schemas/PublicExecutionTranslationRule' functions: type: array description: >- Uma matriz de identificadores de função associados à ação, em que cada item é um PublicActionFunctionIdentifier. items: $ref: '#/components/schemas/PublicActionFunctionIdentifier' id: type: string description: O identificador exclusivo para a definição da ação. É uma string. inputFieldDependencies: type: array description: >- Uma matriz de dependências entre campos de entrada, em que cada item pode ser PublicSingleFieldDependency ou PublicConditionalSingleFieldDependency. items: oneOf: - $ref: '#/components/schemas/PublicSingleFieldDependency' - $ref: '#/components/schemas/PublicConditionalSingleFieldDependency' inputFields: type: array description: >- Uma matriz de definições de campo de entrada necessárias para a ação. Cada item é um objeto PublicInputFieldDefinition. items: $ref: '#/components/schemas/PublicInputFieldDefinition' labels: type: object additionalProperties: $ref: '#/components/schemas/PublicActionLabels' description: >- Um objeto que contém rótulos para a ação, com cada propriedade sendo um objeto PublicActionLabels. objectRequestOptions: $ref: '#/components/schemas/PublicObjectRequestOptions' objectTypes: type: array description: >- Uma matriz de strings que representam os tipos de objetos associados à ação. items: type: string outputFields: type: array description: >- Uma matriz de definições de campo de saída produzidas pela ação. Cada item é um objeto OutputFieldDefinition. items: $ref: '#/components/schemas/OutputFieldDefinition' published: type: boolean description: >- Um booleano que indica se a ação está publicada e disponível para uso. revisionId: type: string description: >- O identificador exclusivo para a revisão atual da definição da ação. É uma string. Error: required: - category - correlationId - message type: object properties: category: type: string description: A categoria de erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Um identificador exclusivo para a solicitação. Inclua este valor em relatórios de erro ou tickets de suporte format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: mais informações sobre o erro items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Um mapa de nomes de links para URIs associados que contêm documentação sobre o erro ou as etapas de correção recomendadas message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado example: An error occurred subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa uma resposta de erro retornada pela API quando uma operação falha. Este componente é usado em vários endpoints para fornecer informações detalhadas sobre o erro encontrado. example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base NextPage: required: - after type: object properties: after: type: string description: >- Um token de string que indica a posição após o último item na página atual. Este token é usado para buscar a próxima página de resultados. link: type: string description: >- Um URL de string que fornece um link direto para a próxima página de resultados. description: >- Specifies the paging information needed to retrieve the next set of results in a paginated API response PublicExecutionTranslationRule: required: - conditions - labelName type: object properties: conditions: type: object additionalProperties: type: object properties: {} description: >- Define as condições que devem ser atendidas para que a regra de execução seja aplicada. labelName: type: string description: Especifica o nome do rótulo associado à regra de execução. PublicActionFunctionIdentifier: required: - functionType type: object properties: functionType: type: string description: >- O tipo de função. Os valores aceitos são: POST_ACTION_EXECUTION, POST_FETCH_OPTIONS, PRE_ACTION_EXECUTION, PRE_FETCH_OPTIONS. enum: - POST_ACTION_EXECUTION - POST_FETCH_OPTIONS - PRE_ACTION_EXECUTION - PRE_FETCH_OPTIONS id: type: string description: O identificador exclusivo da função. PublicSingleFieldDependency: title: SINGLE_FIELD required: - controllingFieldName - dependencyType - dependentFieldNames type: object properties: controllingFieldName: type: string description: O nome do campo que controla a dependência. dependencyType: type: string description: O tipo de dependência, com o valor padrão sendo 'SINGLE_FIELD'. default: SINGLE_FIELD enum: - SINGLE_FIELD dependentFieldNames: type: array description: >- Uma matriz de strings que representa os nomes dos campos dependentes do campo controlador. items: type: string x-hubspot-sub-type-impl: true PublicConditionalSingleFieldDependency: title: CONDITIONAL_SINGLE_FIELD required: - controllingFieldName - controllingFieldValue - dependencyType - dependentFieldNames type: object properties: controllingFieldName: type: string description: O nome do campo que determina a dependência. controllingFieldValue: type: string description: O valor do campo de controle que aciona os gatilhos de dependência. dependencyType: type: string description: >- O tipo de dependência, com o valor padrão sendo CONDITIONAL_SINGLE_FIELD. default: CONDITIONAL_SINGLE_FIELD enum: - CONDITIONAL_SINGLE_FIELD dependentFieldNames: type: array description: >- Uma matriz de strings que representa os nomes dos campos que dependem do campo controlador. items: type: string x-hubspot-sub-type-impl: true PublicInputFieldDefinition: required: - isRequired - typeDefinition type: object properties: isRequired: type: boolean description: Indica se o campo de entrada é obrigatório. supportedValueTypes: type: array description: >- Uma matriz que indica os tipos de valores que o campo de entrada pode aceitar. Os valores válidos incluem 'STATIC_VALUE' e 'OBJECT_PROPERTY'. items: type: string enum: - STATIC_VALUE - OBJECT_PROPERTY typeDefinition: $ref: '#/components/schemas/PublicFieldTypeDefinition' PublicActionLabels: required: - actionName type: object properties: actionCardContent: type: string description: Conteúdo exibido no cartão de ação. actionDescription: type: string description: Uma descrição do que a ação faz. actionName: type: string description: O nome da ação. appDisplayName: type: string description: O nome de exibição do aplicativo associado à ação. executionRules: type: object additionalProperties: type: string description: As regras que regem a execução da ação. inputFieldDescriptions: type: object additionalProperties: type: string description: Descrições para cada campo de entrada. inputFieldLabels: type: object additionalProperties: type: string description: Rótulos para os campos de entrada. inputFieldOptionLabels: type: object additionalProperties: type: object additionalProperties: type: string description: Os rótulos para as opções disponíveis nos campos de entrada. outputFieldLabels: type: object additionalProperties: type: string description: Rótulos para os campos de saída. PublicObjectRequestOptions: required: - properties type: object properties: properties: type: array description: >- Uma matriz de strings que representa os nomes das propriedades a serem solicitadas. Cada string na matriz especifica uma propriedade do objeto que deve ser incluída na resposta. items: type: string OutputFieldDefinition: required: - typeDefinition type: object properties: typeDefinition: $ref: '#/components/schemas/FieldTypeDefinition' ErrorDetail: required: - message type: object properties: code: type: string description: O código de status associado ao detalhe do erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: '{missingScopes=[scope1, scope2]}' in: type: string description: O nome do campo ou parâmetro no qual o erro foi encontrado. message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa informações detalhadas sobre um erro ocorrido na API. Este componente é usado para fornecer contexto e detalhes adicionais sobre os erros, geralmente como parte de uma resposta de erro. PublicFieldTypeDefinition: required: - name - options - type type: object properties: description: type: string description: Uma explicação detalhada da finalidade do campo. fieldType: type: string description: >- O tipo de campo, com valores aceitos incluindo booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text e textarea. enum: - booleancheckbox - calculation_equation - checkbox - date - file - html - number - phonenumber - radio - select - text - textarea helpText: type: string description: Informações ou orientações adicionais sobre o campo. label: type: string description: Um nome amigável para o campo. name: type: string description: O nome interno usado para identificar o campo. options: type: array description: >- Uma variedade de opções disponíveis para o campo, cada uma definida pelo esquema PublicOption. items: $ref: '#/components/schemas/PublicOption' optionsUrl: type: string description: Um URL que fornece opções para o campo. referencedObjectType: type: string description: >- O tipo de objeto que o campo referencia, com valores aceitos incluindo PROPRIETÁRIO. enum: - OWNER type: type: string description: >- O tipo de dados do campo. Os valores aceitos incluem: bool, date, datetime, enumeration, json, number, object_coordinates, phone_number e string. enum: - bool - date - datetime - enumeration - json - number - object_coordinates - phone_number - string FieldTypeDefinition: required: - externalOptions - name - options - schema - type - useChirp type: object properties: description: type: string description: Uma explicação detalhada da finalidade e do uso do campo. externalOptions: type: boolean description: Indica se as opções do campo são de origem externa. externalOptionsReferenceType: type: string description: Especifica o tipo de referência externa para as opções. fieldType: type: string description: >- Descreve o tipo de campo na interface do usuário, com valores aceitos como booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text, textarea, unknown. enum: - booleancheckbox - calculation_equation - calculation_read_time - calculation_rollup - calculation_score - checkbox - date - file - html - number - phonenumber - radio - select - text - textarea - unknown helpText: type: string description: Informações ou orientações adicionais sobre o campo. label: type: string description: O rótulo amigável para o campo. name: type: string description: O identificador exclusivo do campo. options: type: array description: >- Uma variedade de opções disponíveis para o campo, cada uma representada por um objeto Option. items: $ref: '#/components/schemas/Option' optionsUrl: type: string description: Um URL que fornece opções para o campo. referencedObjectType: type: string description: >- Indica o tipo de objeto que o campo referencia. Os valores aceitos incluem: OWNER. enum: - ABANDONED_CART - ACCEPTANCE_TEST - AD - AD_ACCOUNT - AD_CAMPAIGN - AD_GROUP - AI_FORECAST - ALL_PAGES - APPROVAL - APPROVAL_STEP - ATTRIBUTION - AUDIENCE - AUTOMATION_JOURNEY - AUTOMATION_PLATFORM_FLOW - AUTOMATION_PLATFORM_FLOW_ACTION - BET_ALERT - BET_DELIVERABLE_SERVICE - BLOG_LISTING_PAGE - BLOG_POST - CALL - CAMPAIGN - CAMPAIGN_BUDGET_ITEM - CAMPAIGN_SPEND_ITEM - CAMPAIGN_STEP - CAMPAIGN_TEMPLATE - CAMPAIGN_TEMPLATE_STEP - CART - CASE_STUDY - CHATFLOW - CLIP - CMS_URL - COMBO_EVENT_CONFIGURATION - COMMERCE_PAYMENT - COMMUNICATION - COMPANY - CONTACT - CONTACT_CREATE_ATTRIBUTION - CONTENT - CONTENT_AUDIT - CONTENT_AUDIT_PAGE - CONVERSATION - CONVERSATION_INBOX - CONVERSATION_SESSION - CRM_OBJECTS_DUMMY_TYPE - CRM_PIPELINES_DUMMY_TYPE - CTA - CTA_VARIANT - DATA_PRIVACY_CONSENT - DATA_SYNC_STATE - DEAL - DEAL_CREATE_ATTRIBUTION - DEAL_REGISTRATION - DEAL_SPLIT - DISCOUNT - DISCOUNT_CODE - DISCOUNT_TEMPLATE - EMAIL - ENGAGEMENT - EXPORT - EXTERNAL_WEB_URL - FEE - FEEDBACK_SUBMISSION - FEEDBACK_SURVEY - FILE_MANAGER_FILE - FILE_MANAGER_FOLDER - FOLDER - FORECAST - FORM - FORM_SUBMISSION_INBOUNDDB - GOAL_TARGET - GOAL_TARGET_GROUP - GOAL_TEMPLATE - GSC_PROPERTY - HUB - IMPORT - INVOICE - KEYWORD - KNOWLEDGE_ARTICLE - LANDING_PAGE - LEAD - LINE_ITEM - MARKETING_CALENDAR - MARKETING_CAMPAIGN_UTM - MARKETING_EMAIL - MARKETING_EVENT - MARKETING_EVENT_ATTENDANCE - MARKETING_SMS - MEDIA_BRIDGE - MEETING_EVENT - MIC - NOTE - OBJECT_LIST - ORDER - OWNER - PARTNER_ACCOUNT - PARTNER_CLIENT - PARTNER_CLIENT_REVENUE - PARTNER_SERVICE - PAYMENT_LINK - PAYMENT_SCHEDULE - PAYMENT_SCHEDULE_INSTALLMENT - PERMISSIONS_TESTING - PLAYBOOK - PLAYBOOK_QUESTION - PLAYBOOK_SUBMISSION - PLAYBOOK_SUBMISSION_ANSWER - PLAYLIST - PLAYLIST_FOLDER - PODCAST_EPISODE - PORTAL - PORTAL_OBJECT_SYNC_MESSAGE - POSTAL_MAIL - PRIVACY_SCANNER_COOKIE - PRODUCT - PRODUCT_OR_FOLDER - PROPERTY_INFO - PROSPECTING_AGENT_CONTACT_ASSIGNMENT - PUBLISHING_TASK - QUARANTINED_SUBMISSION - QUOTA - QUOTE - QUOTE_FIELD - QUOTE_MODULE - QUOTE_MODULE_FIELD - QUOTE_TEMPLATE - RESTORABLE_CRM_OBJECT - ROSTER - ROSTER_MEMBER - SALES_DOCUMENT - SALES_TASK - SALES_WORKLOAD - SALESFORCE_SYNC_ERROR - SCHEDULING_PAGE - SCHEMAS_BACKEND_TEST - SCORE_CONFIGURATION - SEQUENCE - SEQUENCE_ENROLLMENT - SEQUENCE_STEP - SEQUENCE_STEP_ENROLLMENT - SERVICE - SITE_PAGE - SNIPPET - SOCIAL_BROADCAST - SOCIAL_CHANNEL - SOCIAL_POST - SOCIAL_PROFILE - SOX_PROTECTED_DUMMY_TYPE - SOX_PROTECTED_TEST_TYPE - SUBMISSION_TAG - SUBSCRIPTION - TASK - TASK_TEMPLATE - TAX - TEMPLATE - TICKET - UNKNOWN - UNSUBSCRIBE - USER - VIEW - VIEW_BLOCK - WEB_INTERACTIVE schema: description: Define a estrutura e as restrições do campo. oneOf: - $ref: '#/components/schemas/IntegerFieldSchema' - $ref: '#/components/schemas/LongFieldSchema' - $ref: '#/components/schemas/DoubleFieldSchema' - $ref: '#/components/schemas/StringFieldSchema' - $ref: '#/components/schemas/BooleanFieldSchema' - $ref: '#/components/schemas/ArrayFieldSchema' - $ref: '#/components/schemas/ObjectFieldSchema' - $ref: '#/components/schemas/UnknownFieldSchema' type: type: string description: >- Especifica o tipo de dados do campo, com valores aceitos como bool, date, datetime, enumeration, json, number, object_coordinates, phone_number, string. enum: - bool - currency_number - date - datetime - enumeration - json - number - object_coordinates - phone_number - string - time_range useChirp: type: boolean description: Especifica se o campo usa o recurso Chirp. PublicOption: required: - label - value type: object properties: description: type: string description: Uma descrição da opção. displayOrder: type: integer description: A posição da opção em relação às outras na lista. format: int32 label: type: string description: Um rótulo amigável que identifica a opção. value: type: string description: O valor real da opção. Option: required: - description - displayOrder - doubleData - hidden - label - readOnly - value type: object properties: description: type: string description: Uma string que fornece detalhes adicionais sobre a opção. displayOrder: type: integer description: >- Um número inteiro que indica a ordem em que a opção deve ser exibida em relação a outras opções. format: int32 doubleData: type: number description: Um valor numérico associado à opção. hidden: type: boolean description: >- Um booleano que indica se a opção está oculta da interface do usuário. label: type: string description: O nome de exibição da opção, mostrado aos usuários. É uma string. readOnly: type: boolean description: >- Um booleano que indica se a opção é somente leitura e não pode ser modificada. value: type: string description: >- O valor interno da opção, usado no processamento de dados. É uma string. description: A HubSpot property option IntegerFieldSchema: title: INTEGER required: - type type: object properties: maximum: type: integer description: O valor máximo permitido para o campo inteiro. format: int32 minimum: type: integer description: O valor mínimo permitido para o campo inteiro. format: int32 type: type: string description: O tipo de campo, que é definido como INTEGER. default: INTEGER enum: - INTEGER x-hubspot-sub-type-impl: true LongFieldSchema: title: LONG required: - type type: object properties: maximum: type: integer description: O valor máximo permitido para o campo longo. format: int64 minimum: type: integer description: O valor mínimo permitido para o campo longo. format: int64 type: type: string description: O tipo do campo, que é LONG por padrão. default: LONG enum: - LONG x-hubspot-sub-type-impl: true DoubleFieldSchema: title: DOUBLE required: - type type: object properties: maximum: type: number description: O valor máximo permitido para o campo duplo. minimum: type: number description: O valor mínimo permitido para o campo duplo. type: type: string description: Indica o tipo de campo como DOUBLE. default: DOUBLE enum: - DOUBLE x-hubspot-sub-type-impl: true StringFieldSchema: title: STRING required: - type type: object properties: format: type: string description: >- Especifica o formato da string. Os valores aceitos incluem: DATE, DATE_TIME, OBJECT_COORDINATE, TIME, URI. enum: - DATE - DATE_TIME - MONTH_AND_DAY - OBJECT_COORDINATE - OBJECT_TYPE - TIME - URI type: type: string description: Indica que o tipo é uma string, com o valor padrão sendo STRING. default: STRING enum: - STRING x-hubspot-sub-type-impl: true BooleanFieldSchema: title: BOOLEAN required: - type type: object properties: type: type: string description: >- Especifica o tipo de campo como BOOLEAN, indicando que o campo pode conter um valor verdadeiro ou falso. default: BOOLEAN enum: - BOOLEAN x-hubspot-sub-type-impl: true ArrayFieldSchema: title: ARRAY required: - items - type type: object properties: items: description: >- Define o tipo de elemento contidos na matriz, que pode ser um número inteiro, longo, duplo, string, booleano, outra matriz ou um objeto. oneOf: - $ref: '#/components/schemas/IntegerFieldSchema' - $ref: '#/components/schemas/LongFieldSchema' - $ref: '#/components/schemas/DoubleFieldSchema' - $ref: '#/components/schemas/StringFieldSchema' - $ref: '#/components/schemas/BooleanFieldSchema' - $ref: '#/components/schemas/ArrayFieldSchema' - $ref: '#/components/schemas/ObjectFieldSchema' - $ref: '#/components/schemas/UnknownFieldSchema' type: type: string description: Especifica que o campo é do tipo 'ARRAY'. default: ARRAY enum: - ARRAY x-hubspot-sub-type-impl: true ObjectFieldSchema: title: OBJECT required: - properties - type type: object properties: properties: type: object properties: {} description: Contém as propriedades do objeto. type: type: string description: Especifica o tipo do campo, que é 'OBJETO' por padrão. default: OBJECT enum: - OBJECT x-hubspot-sub-type-impl: true UnknownFieldSchema: title: UNKNOWN required: - type type: object properties: type: type: string description: >- Uma string que indica o tipo do campo. Neste esquema, ela é sempre definida como 'UNKNOWN'. default: UNKNOWN enum: - UNKNOWN x-hubspot-sub-type-impl: true responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' securitySchemes: developer_hapikey: type: apiKey name: hapikey in: query ````