> ## 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 all subscription status definitions > Obtenha uma lista de definições de status de assinatura a partir da conta. > **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: Recuperar todas as definições de status de assinatura description: >- Obtenha uma lista de definições de status de assinatura a partir da conta. operationId: get-/communication-preferences/2026-09/definitions parameters: - name: businessUnitId in: query description: >- Um número inteiro que representa o identificador exclusivo da unidade de negócios para a qual recuperar as definições de preferências de comunicação. required: false style: form explode: true schema: type: integer format: int64 - name: includeTranslations in: query description: >- Um booleano que indica se as traduções para as definições de assinatura devem ser incluídas. O padrão é falso se não for especificado. 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: A data e a hora em que a operação foi concluída. format: date-time errors: type: array description: Uma série de erros que ocorreram durante a operação. items: $ref: '#/components/schemas/StandardError' links: type: object additionalProperties: type: string description: Uma coleção de links relacionados associados à operação. numErrors: type: integer description: O número de erros encontrados durante a operação. format: int32 requestedAt: type: string description: A data e a hora em que a operação foi solicitada. format: date-time results: type: array description: Uma série contendo os resultados da operação. items: $ref: '#/components/schemas/SubscriptionDefinition' startedAt: type: string description: A data e a hora em que a operação começou. format: date-time status: type: string description: >- O status atual da operação, que pode ser PENDING, PROCESSING, CANCELED ou COMPLETE. enum: - CANCELED - COMPLETE - PENDING - PROCESSING StandardError: required: - category - context - errors - links - message - status type: object properties: category: type: string description: Uma string que categoriza o tipo de erro. context: type: object additionalProperties: type: array items: type: string description: >- Um objeto que contém contexto adicional sobre a condição de erro, com chaves como nomes de contexto e valores como matrizes de strings. errors: type: array description: >- Uma matriz de objetos ErrorDetail que fornece mais informações sobre o erro. items: $ref: '#/components/schemas/ErrorDetail' id: type: string description: Uma string que representa o identificador exclusivo do erro. links: type: object additionalProperties: type: string description: >- Um objeto que mapeia 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 string contendo uma mensagem legível por humanos que descreve o erro. status: type: string description: Uma string que indica o status do erro. subCategory: type: object properties: {} description: Um objeto que fornece uma categorização mais específica do erro. description: Ye olde error SubscriptionDefinition: required: - createdAt - description - id - isActive - isDefault - isInternal - name - updatedAt type: object properties: businessUnitId: type: integer description: O ID da unidade de negócios associada à assinatura. format: int64 communicationMethod: type: string description: O método de comunicação para a assinatura. createdAt: type: string description: A data e a hora em que a assinatura foi criada. format: date-time description: type: string description: Uma descrição da assinatura. id: type: string description: O identificador exclusivo da assinatura. isActive: type: boolean description: Indica se a assinatura está ativa. isDefault: type: boolean description: Indica se a assinatura é a opção padrão. isInternal: type: boolean description: Indica se a assinatura é interna. name: type: string description: O nome da assinatura. purpose: type: string description: O objetivo da assinatura. subscriptionTranslations: type: array description: Uma lista de traduções associadas à assinatura. items: $ref: '#/components/schemas/PublicSubscriptionTranslation' updatedAt: type: string description: A data e a hora em que a assinatura foi atualizada pela última vez. format: date-time 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 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. PublicSubscriptionTranslation: required: - createdAt - description - languageCode - name - subscriptionId - updatedAt type: object properties: createdAt: type: integer description: >- A data e hora que indicam quando a tradução da assinatura foi criada. format: int64 description: type: string description: Uma descrição de texto da tradução da assinatura. languageCode: type: string description: O código que representa o idioma da tradução da assinatura. name: type: string description: O nome da tradução da assinatura. subscriptionId: type: integer description: O identificador exclusivo da assinatura associada à tradução. format: int64 updatedAt: type: integer description: >- A data e hora que indicam quando a tradução da assinatura foi atualizada pela última vez. 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: '' ````