> ## 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 all subscription status definitions > Obtenez une liste de toutes les définitions de statut d'abonnement à partir du compte. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/2026-09/communication-preferences-subscriptions-v2026-09.json GET /communication-preferences/2026-09/definitions openapi: 3.0.1 info: title: Communication Preferences Subscriptions description: Basepom for all HubSpot Projects version: 2026-09 x-hubspot-product-tier-requirements: marketing: STARTER sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE servers: - url: https://api.hubapi.com security: [] tags: - name: Batch - name: Definitions - name: Status paths: /communication-preferences/2026-09/definitions: get: tags: - Definitions summary: Récupérer toutes les définitions de statut d'abonnement description: >- Obtenez une liste de toutes les définitions de statut d'abonnement à partir du compte. operationId: get-/communication-preferences/2026-09/definitions parameters: - name: businessUnitId in: query description: >- Un entier représentant l'identifiant unique de l'unité commerciale pour laquelle récupérer les définitions des préférences de communication. required: false style: form explode: true schema: type: integer format: int64 - name: includeTranslations in: query description: "Un booléen indiquant s'il faut inclure les traductions des définitions d'abonnement. La valeur par défaut est «\_false\_» si elle n'est pas spécifiée." required: false style: form explode: true schema: type: boolean responses: '200': description: successful operation content: application/json: schema: $ref: >- #/components/schemas/ActionResponseWithResultsSubscriptionDefinition default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - communication_preferences.read_write components: schemas: ActionResponseWithResultsSubscriptionDefinition: required: - completedAt - results - startedAt - status type: object properties: completedAt: type: string description: La date et l'heure de la fin de l'opération. format: date-time errors: type: array description: Une série d'erreurs survenues pendant l'opération. items: $ref: '#/components/schemas/StandardError' links: type: object additionalProperties: type: string description: Une collection de liens associés à l'opération. numErrors: type: integer description: Le nombre d'erreurs rencontrées pendant l'opération. format: int32 requestedAt: type: string description: La date et l'heure auxquelles l'opération a été demandée. format: date-time results: type: array description: Un tableau contenant les résultats de l'opération. items: $ref: '#/components/schemas/SubscriptionDefinition' startedAt: type: string description: La date et l'heure du début de l'opération. format: date-time status: type: string description: >- Le statut actuel de l'opération, qui peut être EN ATTENTE, EN COURS DE TRAITEMENT, ANNULÉE ou TERMINÉE. enum: - CANCELED - COMPLETE - PENDING - PROCESSING StandardError: required: - category - context - errors - links - message - status type: object properties: category: type: string description: Une chaîne qui catégorise le type d'erreur. context: type: object additionalProperties: type: array items: type: string description: >- Un objet contenant un contexte supplémentaire sur la condition d'erreur, avec des clés comme noms de contexte et des valeurs comme tableaux de chaînes de caractères. errors: type: array description: >- Un tableau d'objets ErrorDetail fournissant des informations supplémentaires sur l'erreur. items: $ref: '#/components/schemas/ErrorDetail' id: type: string description: Une chaîne représentant l'identifiant unique de l'erreur. links: type: object additionalProperties: type: string description: >- Un objet associant des noms de liens à des URI connexes qui contiennent de la documentation sur l'erreur ou des étapes de remédiation recommandées pour celle-ci. message: type: string description: Message lisible par l'être humain décrivant l'erreur. status: type: string description: Une chaîne indiquant le statut de l'erreur. subCategory: type: object properties: {} description: Un objet fournissant une catégorisation plus spécifique de l'erreur. description: Ye olde error SubscriptionDefinition: required: - createdAt - description - id - isActive - isDefault - isInternal - name - updatedAt type: object properties: businessUnitId: type: integer description: L'IDde l'unité commerciale associée à l'abonnement. format: int64 communicationMethod: type: string description: Le mode de communication pour l'abonnement. createdAt: type: string description: La date et l'heure de création de l'abonnement. format: date-time description: type: string description: Une description de l'abonnement. id: type: string description: L'identifiant unique pour l'abonnement. isActive: type: boolean description: Indique si l'abonnement est actif. isDefault: type: boolean description: Indique si l'abonnement est l'option par défaut. isInternal: type: boolean description: Indique si l'abonnement est interne. name: type: string description: Le nom de l'abonnement. purpose: type: string description: L'objectif de l'abonnement. subscriptionTranslations: type: array description: Une liste des traductions associées à l'abonnement. items: $ref: '#/components/schemas/PublicSubscriptionTranslation' updatedAt: type: string description: La date et l'heure de la dernière mise à jour de l'abonnement. format: date-time 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 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. PublicSubscriptionTranslation: required: - createdAt - description - languageCode - name - subscriptionId - updatedAt type: object properties: createdAt: type: integer description: >- L'horodatage indiquant la date de création de la traduction de l'abonnement. format: int64 description: type: string description: Une description textuelle de la traduction de l'abonnement. languageCode: type: string description: Le code représentant la langue de la traduction de l'abonnement. name: type: string description: Le nom de la traduction de l'abonnement. subscriptionId: type: integer description: L'identifiant unique de l'abonnement associé à la traduction. format: int64 updatedAt: type: integer description: >- L'horodatage indiquant la date de la dernière mise à jour de la traduction de l'abonnement. format: int64 responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://app.hubspot.com/oauth/authorize tokenUrl: https://api.hubapi.com/oauth/v1/token scopes: communication_preferences.read_write: '' communication_preferences.statuses.batch.read: '' communication_preferences.statuses.batch.write: '' ````