> ## 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 domains > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/legacy/v3/cms-domains-v3.json GET /cms/v3/domains openapi: 3.0.1 info: title: Domínios version: v3 x-hubspot-product-tier-requirements: marketing: FREE sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE x-hubspot-api-use-case: >- Recupere todos os domínios conectados no momento para ver quais sites estão ativos em uma determinada conta. x-hubspot-related-documentation: - name: Domains Guide url: https://developers.hubspot.com/docs/guides/api/cms/domains x-hubspot-introduction: >- Use a API de gerenciamento de domínio para retornar informações sobre os domínios conectados a uma conta da HubSpot. Você pode retornar dados para todos os domínios conectados no momento ou para um domínio único por ID. servers: - url: https://api.hubapi.com security: [] tags: - name: Basic paths: /cms/v3/domains: get: tags: - Basic operationId: get-/cms/v3/domains_/cms/v3/domains parameters: - name: after in: query required: false style: form explode: true schema: type: string - name: archived in: query required: false style: form explode: true schema: type: boolean - name: createdAfter in: query required: false style: form explode: true schema: type: string format: date-time - name: createdAt in: query required: false style: form explode: true schema: type: string format: date-time - name: createdBefore in: query required: false style: form explode: true schema: type: string format: date-time - name: limit in: query required: false style: form explode: true schema: type: integer format: int32 - name: sort in: query required: false style: form explode: true schema: type: array items: type: string - name: updatedAfter in: query required: false style: form explode: true schema: type: string format: date-time - name: updatedAt in: query required: false style: form explode: true schema: type: string format: date-time - name: updatedBefore in: query required: false style: form explode: true schema: type: string format: date-time responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/CollectionResponseWithTotalDomain' default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - cms.domains.write - oauth2: - cms.knowledge_base.settings.read - oauth2: - cms.knowledge_base.settings.write - oauth2: - cms.domains.read - oauth2: - content components: schemas: CollectionResponseWithTotalDomain: required: - results - total type: object properties: paging: $ref: '#/components/schemas/Paging' results: type: array description: Os resultados da consulta. items: $ref: '#/components/schemas/Domain' total: type: integer description: O número de resultados disponíveis. format: int32 Paging: type: object properties: next: $ref: '#/components/schemas/NextPage' prev: $ref: '#/components/schemas/PreviousPage' description: >- Representa as informações de paginação para navegar por uma lista de resultados na API. Ele fornece detalhes sobre como acessar o conjunto anterior ou seguinte de resultados. Domain: required: - domain - id - isResolving - isUsedForBlogPost - isUsedForEmail - isUsedForKnowledge - isUsedForLandingPage - isUsedForSitePage type: object properties: correctCname: type: string description: O registro CNAME esperado para o domínio. created: type: string description: A data e a hora de criação do domínio. format: date-time domain: type: string description: 'O domínio ou subdomínio real. Exemplo: www.hubspot.com.' id: type: string description: O ID exclusivo deste domínio. isResolving: type: boolean description: >- Se o DNS deste domínio está configurado de forma otimizada para uso com o HubSpot. isSslEnabled: type: boolean description: Indica se o SSL está habilitado para o domínio. isSslOnly: type: boolean description: Indica se o domínio pode ser acessado somente via SSL. isUsedForBlogPost: type: boolean description: Se o domínio é usado para posts de blog do CMS. isUsedForEmail: type: boolean description: Se o domínio é usado para páginas de e-mail do CMS. isUsedForKnowledge: type: boolean description: Se o domínio é usado para páginas de conhecimento do CMS. isUsedForLandingPage: type: boolean description: Se o domínio é usado para landing pages do CMS. isUsedForSitePage: type: boolean description: Se o domínio é usado para páginas do site do CMS. manuallyMarkedAsResolving: type: boolean description: Indica se o domínio foi marcado manualmente como resolvido. primaryBlogPost: type: boolean description: Indica se o domínio é o domínio principal para posts de blog. primaryEmail: type: boolean description: Indica se o domínio é o domínio principal para páginas de e-mail. primaryKnowledge: type: boolean description: >- Indica se o domínio é o domínio principal para páginas de conhecimento. primaryLandingPage: type: boolean description: Indica se o domínio é o domínio principal para landing pages. primarySitePage: type: boolean description: Indica se o domínio é o domínio principal para páginas do site. secondaryToDomain: type: string description: Especifica o domínio ao qual este domínio é secundário. updated: type: string description: A data e a hora em que o domínio foi atualizado 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 NextPage: required: - after type: object properties: after: type: string description: >- O valor do cursor que indica onde começar a buscar a próxima página de resultados em uma coleção paginada link: type: string description: >- Um URL opcional para acessar diretamente a próxima página de resultados. description: >- Especifica as informações de paginação necessárias para recuperar o próximo conjunto de resultados em uma resposta de API paginada PreviousPage: required: - before type: object properties: before: type: string description: A paging cursor token for retrieving previous pages. link: type: string description: A URL that can be used to retrieve the previous pages' results. description: >- specifies the paging information needed to retrieve the previous set of results in a paginated API response 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. 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: cms.domains.read: '' cms.domains.write: '' cms.knowledge_base.settings.read: '' cms.knowledge_base.settings.write: '' content: '' ````