> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.fr/docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve custom action definitions > Récupérez les définitions d'actions de workflows personnalisées par ID d'application. > **Supported products** ## OpenAPI ````yaml specs/legacy/v4/automation-actions-v4-v4.json GET /automation/v4/actions/{appId} openapi: 3.0.1 info: title: Automation Actions V4 description: Basepom for all HubSpot Projects version: v4 x-hubspot-product-tier-requirements: marketing: PROFESSIONAL sales: PROFESSIONAL service: PROFESSIONAL cms: PROFESSIONAL commerce: PROFESSIONAL crmHub: PROFESSIONAL dataHub: PROFESSIONAL x-hubspot-related-documentation: - name: Custom Workflow Actions Guide url: >- https://developers.hubspot.com/docs/guides/api/automation/custom-workflow-actions servers: - url: https://api.hubapi.com security: [] tags: - name: Callbacks - name: Definitions - name: Functions - name: Revisions paths: /automation/v4/actions/{appId}: get: tags: - Definitions summary: Récupérer les définitions d'actions personnalisées description: >- Récupérez les définitions d'actions de workflows personnalisées par ID d'application. operationId: get-/automation/v4/actions/{appId}_getPage parameters: - name: appId in: path description: Identifiant unique de l'application. required: true style: simple explode: false schema: type: integer format: int32 - name: after in: query description: >- Le jeton de curseur de pagination de la dernière ressource lue avec succès sera renvoyé en tant que propriété JSON `paging.next.after` d'une réponse paginée contenant plus de résultats. required: false style: form explode: true schema: type: string - name: archived in: query description: S'il faut renvoyer uniquement les résultats qui ont été archivés. required: false style: form explode: true schema: type: boolean default: false - name: limit in: query description: Le nombre maximum de résultats à afficher par page. 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 items: $ref: '#/components/schemas/PublicActionDefinition' ForwardPaging: type: object properties: next: $ref: '#/components/schemas/NextPage' description: "Informations de pagination pour une pagination unidirectionnelle. Contient la référence de la page suivante lorsque d'autres résultats sont disponibles\_; omis ou vide sur la dernière page." PublicActionDefinition: required: - actionUrl - functions - id - inputFields - labels - objectTypes - published - revisionId type: object properties: actionUrl: type: string archivedAt: type: integer format: int64 executionRules: type: array items: $ref: '#/components/schemas/PublicExecutionTranslationRule' functions: type: array items: $ref: '#/components/schemas/PublicActionFunctionIdentifier' id: type: string inputFieldDependencies: type: array items: oneOf: - $ref: '#/components/schemas/PublicSingleFieldDependency' - $ref: '#/components/schemas/PublicConditionalSingleFieldDependency' inputFields: type: array items: $ref: '#/components/schemas/PublicInputFieldDefinition' labels: type: object additionalProperties: $ref: '#/components/schemas/PublicActionLabels' objectRequestOptions: $ref: '#/components/schemas/PublicObjectRequestOptions' objectTypes: type: array items: type: string outputFields: type: array items: $ref: '#/components/schemas/OutputFieldDefinition' published: type: boolean revisionId: type: string Error: required: - category - correlationId - message type: object properties: category: type: string description: La catégorie d'erreur context: type: object additionalProperties: type: array items: type: string description: Contexte concernant la condition d'erreur example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Un identifiant unique pour la demande. Incluez cette valeur dans tous les rapports d'erreurs ou tickets d'assistance format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: informations supplémentaires à propos de l'erreur items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Une carte des noms de liens vers les URI associés contenant de la documentation sur l'erreur ou les mesures correctives recommandées message: type: string description: >- Un message lisible par la personne décrivant l'erreur ainsi que les mesures correctives possibles, le cas échéant example: An error occurred subCategory: type: string description: >- Une catégorie spécifique qui contient des détails plus précis sur l'erreur description: >- Représente une réponse d'erreur renvoyée par l'API lorsqu'une opération échoue. Ce composant est utilisé dans divers points de terminaison pour fournir des informations détaillées sur l'erreur rencontrée. 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: >- Un jeton de curseur de pagination pour récupérer les pages suivantes. link: type: string description: >- Une URL qui peut être utilisée pour récupérer les résultats de la page suivante. description: >- Spécifie les informations de pagination nécessaires pour récupérer le prochain ensemble de résultats dans une réponse d'API paginée PublicExecutionTranslationRule: required: - conditions - labelName type: object properties: conditions: type: object additionalProperties: type: object properties: {} description: >- Définit les conditions à remplir pour que la règle d'exécution s'applique. labelName: type: string description: Spécifie le nom de l'étiquette associée à la règle d'exécution. PublicActionFunctionIdentifier: required: - functionType type: object properties: functionType: type: string description: >- Le type de fonction, avec les valeurs acceptées : 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: L'identifiant unique de la fonction. PublicSingleFieldDependency: title: SINGLE_FIELD required: - controllingFieldName - dependencyType - dependentFieldNames type: object properties: controllingFieldName: type: string description: Le nom du champ qui contrôle la dépendance. dependencyType: type: string description: >- Le type de dépendance, avec la valeur par défaut étant « SINGLE_FIELD ». default: SINGLE_FIELD enum: - SINGLE_FIELD dependentFieldNames: type: array 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: Le nom du champ qui détermine la dépendance. controllingFieldValue: type: string description: La valeur du champ de contrôle qui déclenche la dépendance. dependencyType: type: string description: >- Le type de dépendance, la valeur par défaut étant CONDITIONAL_SINGLE_FIELD. default: CONDITIONAL_SINGLE_FIELD enum: - CONDITIONAL_SINGLE_FIELD dependentFieldNames: type: array items: type: string x-hubspot-sub-type-impl: true PublicInputFieldDefinition: required: - isRequired - typeDefinition type: object properties: isRequired: type: boolean description: Indique si le champ de saisie est obligatoire. supportedValueTypes: type: array items: type: string enum: - STATIC_VALUE - OBJECT_PROPERTY typeDefinition: $ref: '#/components/schemas/PublicFieldTypeDefinition' PublicActionLabels: required: - actionName type: object properties: actionCardContent: type: string description: Contenu affiché sur la carte d'action. actionDescription: type: string description: Une description de l'action. actionName: type: string description: Le nom de l'action. appDisplayName: type: string description: Le nom d'affichage de l'application associée à l'action. executionRules: type: object additionalProperties: type: string description: Règles régissant l'exécution de l'action. inputFieldDescriptions: type: object additionalProperties: type: string description: Descriptions pour chaque champ de saisie. inputFieldLabels: type: object additionalProperties: type: string description: Libellés des champs de saisie. inputFieldOptionLabels: type: object additionalProperties: type: object additionalProperties: type: string description: Libellés des options disponibles dans les champs de saisie. outputFieldLabels: type: object additionalProperties: type: string description: Libellés des champs de sortie. PublicObjectRequestOptions: required: - properties type: object properties: properties: type: array items: type: string OutputFieldDefinition: required: - typeDefinition type: object properties: typeDefinition: $ref: '#/components/schemas/FieldTypeDefinition' ErrorDetail: required: - message type: object properties: code: type: string description: Le code du statut associé au détail de l'erreur context: type: object additionalProperties: type: array items: type: string description: Contexte concernant la condition d'erreur example: '{missingScopes=[scope1, scope2]}' in: type: string description: Le nom du champ ou du paramètre dans lequel l'erreur a été trouvée. message: type: string description: >- Un message lisible par la personne décrivant l'erreur ainsi que les mesures correctives possibles, le cas échéant subCategory: type: string description: >- Une catégorie spécifique qui contient des détails plus précis sur l'erreur description: >- Représente des informations détaillées sur une erreur survenue dans l'API. Ce composant est utilisé pour fournir un contexte et des spécificités supplémentaires sur les erreurs, généralement dans le cadre d'une réponse d'erreur. PublicFieldTypeDefinition: required: - name - options - type type: object properties: description: type: string description: Une explication détaillée de l'objectif du champ. fieldType: type: string description: >- Le type de champ, avec des valeurs acceptées, incluant booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text et textarea. enum: - booleancheckbox - calculation_equation - checkbox - date - file - html - number - phonenumber - radio - select - text - textarea helpText: type: string description: Information ou conseils supplémentaires concernant le champ. label: type: string description: Nom simple pour le champ. name: type: string description: Le nom interne utilisé pour identifier le champ. options: type: array items: $ref: '#/components/schemas/PublicOption' optionsUrl: type: string description: Une URL qui fournit des options pour le champ. referencedObjectType: type: string description: >- Le type d'objet auquel le champ fait référence, avec des valeurs acceptées incluant OWNER. enum: - OWNER type: type: string description: >- Le type de données du champ, avec les valeurs acceptées incluant bool, date, datetime, enumeration, json, number, object_coordinates, phone_number et 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: >- Une explication détaillée de l'objectif et de l'utilisation du champ. externalOptions: type: boolean description: Indique si les options du champ proviennent d'une source externe. externalOptionsReferenceType: type: string description: Spécifie le type de référence externe pour les options. fieldType: type: string description: >- Décrit le type de champ dans l'interface utilisateur, avec des valeurs acceptées, comme 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: Information ou conseils supplémentaires concernant le champ. label: type: string description: Le libellé simple du champ. name: type: string description: L'identifiant unique du champ. options: type: array items: $ref: '#/components/schemas/Option' optionsUrl: type: string description: Une URL qui fournit des options pour le champ. referencedObjectType: type: string description: >- Indique le type d'objet auquel le champ fait référence, avec des valeurs acceptées comme 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: Définit la structure et les contraintes du champ. 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: >- Spécifie le type de données du champ, avec des valeurs acceptées, comme 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: Spécifie si le champ utilise la fonctionnalité Chirp. PublicOption: required: - label - value type: object properties: description: type: string description: Une description de l'option. displayOrder: type: integer description: La position de l'option par rapport aux autres dans la liste. format: int32 label: type: string description: Un libellé convivial qui identifie l'option. value: type: string description: La valeur réelle de l'option. Option: required: - description - displayOrder - doubleData - hidden - label - readOnly - value type: object properties: description: type: string description: Une description de l'option. displayOrder: type: integer description: >- La position de l'élément par rapport aux autres éléments de la liste. format: int32 doubleData: type: number description: Une valeur numérique associée à l'option. hidden: type: boolean description: Si l'option est affichée dans l'interface utilisateur de HubSpot label: type: string description: Un libellé convivial qui identifie l'option. readOnly: type: boolean description: Indique si l'option est en lecture seule. value: type: string description: La valeur réelle de l'option. description: Une option de propriété HubSpot IntegerFieldSchema: title: INTEGER required: - type type: object properties: maximum: type: integer description: La valeur maximale autorisée pour le champ entier. format: int32 minimum: type: integer description: La valeur minimale autorisée pour le champ entier. format: int32 type: type: string description: Le type de champ, défini sur ENTIER. default: INTEGER enum: - INTEGER x-hubspot-sub-type-impl: true LongFieldSchema: title: LONG required: - type type: object properties: maximum: type: integer description: La valeur maximale autorisée pour le champ long. format: int64 minimum: type: integer description: La valeur minimale autorisée pour le champ long. format: int64 type: type: string description: Le type de champ, qui est LONG par défaut. default: LONG enum: - LONG x-hubspot-sub-type-impl: true DoubleFieldSchema: title: DOUBLE required: - type type: object properties: maximum: type: number description: La valeur maximale autorisée pour le champ double. minimum: type: number description: La valeur minimale autorisée pour le champ double. type: type: string description: Indique le type de champ comme DOUBLE. default: DOUBLE enum: - DOUBLE x-hubspot-sub-type-impl: true StringFieldSchema: title: STRING required: - type type: object properties: format: type: string description: >- Spécifie le format de la chaîne, avec les valeurs acceptées : DATE, DATE_TIME, OBJECT_COORDINATE, TIME, URI. enum: - DATE - DATE_TIME - MONTH_AND_DAY - OBJECT_COORDINATE - OBJECT_TYPE - TIME - URI type: type: string description: >- Indique que le type est une chaîne de caractères, la valeur par défaut étant STRING. default: STRING enum: - STRING x-hubspot-sub-type-impl: true BooleanFieldSchema: title: BOOLEAN required: - type type: object properties: type: type: string description: >- Spécifie le type de champ comme étant BOOLÉEN, ce qui indique que le champ peut contenir une valeur vraie ou fausse. default: BOOLEAN enum: - BOOLEAN x-hubspot-sub-type-impl: true ArrayFieldSchema: title: ARRAY required: - items - type type: object properties: items: description: >- Définit le type d'éléments contenus dans le tableau, qui peut être un entier, un long, un double, une chaîne de caractères, un booléen, un autre tableau ou un objet. 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: Spécifie que le champ est de type « 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: Contient les propriétés de l'objet. type: type: string description: Spécifie le type de champ, qui est « OBJECT » par défaut. default: OBJECT enum: - OBJECT x-hubspot-sub-type-impl: true UnknownFieldSchema: title: UNKNOWN required: - type type: object properties: type: type: string 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 ````