> ## 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.

# Start an export

> Inicia a exportação de dados de CRM para o portal conforme especificado no corpo da solicitação

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-03/crm-exports-v2026-03.json POST /crm/exports/2026-03/export/async
openapi: 3.0.1
info:
  title: CRM Exports
  description: Basepom for all HubSpot Projects
  version: 2026-03
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Advanced
  - name: Basic
paths:
  /crm/exports/2026-03/export/async:
    post:
      tags:
        - Advanced
      summary: Comece uma exportação
      description: >-
        Inicia a exportação de dados de CRM para o portal conforme especificado
        no corpo da solicitação
      operationId: post-/crm/exports/2026-03/export/async_start
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicExportRequest'
        required: true
      responses:
        '202':
          description: accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskLocator'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.export
components:
  schemas:
    PublicExportRequest:
      properties: {}
      oneOf:
        - $ref: '#/components/schemas/PublicExportViewRequest'
        - $ref: '#/components/schemas/PublicExportListRequest'
    TaskLocator:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          description: O ID exclusivo da exportação.
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um objeto contendo links relevantes relacionados ao processo de
            exportação.
    PublicExportViewRequest:
      required:
        - associatedObjectType
        - exportInternalValuesOptions
        - exportName
        - exportType
        - format
        - includeLabeledAssociations
        - includePrimaryDisplayPropertyForAssociatedObjects
        - language
        - objectProperties
        - objectType
        - overrideAssociatedObjectsPerDefinitionPerRowLimit
      type: object
      properties:
        associatedObjectType:
          type: array
          description: >-
            Matriz de strings que indica tipos de objetos associados a serem
            incluídos na exportação.
          items:
            type: string
        exportInternalValuesOptions:
          type: array
          description: >-
            Matriz de strings que especifica opções para valores internos na
            exportação. Valores válidos são "NAMES" e "VALUES".
          items:
            type: string
            enum:
              - NAMES
              - VALUES
        exportName:
          type: string
          description: O nome atribuído à exportação, representado como uma string.
        exportType:
          type: string
          description: Tipo de exportação solicitado. O único valor válido é "VIEW".
          default: VIEW
          enum:
            - VIEW
        format:
          type: string
          description: >-
            Formato de arquivo para a exportação. Opções válidas são "XLS",
            "XLSX" e "CSV".
          enum:
            - CSV
            - XLS
            - XLSX
        includeLabeledAssociations:
          type: boolean
          description: >-
            Booleano que indica se associações rotuladas devem ser incluídas na
            exportação.
        includePrimaryDisplayPropertyForAssociatedObjects:
          type: boolean
          description: >-
            Booleano que indica se a propriedade de exibição principal para
            objetos associados deve ser incluída.
        language:
          type: string
          description: >-
            O código de idioma para a exportação. Os valores válidos incluem
            'EN', 'FR', 'DE', 'JA', 'ES', 'PT_BR', 'NL', 'BN', 'CS', 'DA_DK',
            'EL_GR', 'ES_MX', 'FI', 'HR', 'HU', 'ID', 'IT', 'KO_KR', 'NO', 'PL',
            'RO', 'RU', 'SV', 'TH', 'VI_VN', 'ZH_CN', 'ZH_HK', 'AF_ZA', 'AR_EG',
            'BG', 'CA_ES', 'SL', 'TR', 'UK', 'EN_GB', 'FR_CA', 'HE_IL', 'LT_LT',
            'PT_PT', 'SK_SK', 'MS', 'TL', 'ZH_TW', 'HI_IN', 'ET_EE'.
          enum:
            - AF_ZA
            - AR_EG
            - BG
            - BN
            - CA_ES
            - CS
            - DA_DK
            - DE
            - EL_GR
            - EN
            - EN_GB
            - ES
            - ES_MX
            - ET_EE
            - FI
            - FR
            - FR_CA
            - HE_IL
            - HI_IN
            - HR
            - HU
            - ID
            - IT
            - JA
            - KO_KR
            - LT_LT
            - MS
            - NL
            - 'NO'
            - PL
            - PT_BR
            - PT_PT
            - RO
            - RU
            - SK_SK
            - SL
            - SV
            - TH
            - TL
            - TR
            - UK
            - VI_VN
            - ZH_CN
            - ZH_HK
            - ZH_TW
        objectProperties:
          type: array
          description: >-
            Uma matriz de strings que especifica as propriedades do objeto a
            serem incluídas na exportação.
          items:
            type: string
        objectType:
          type: string
          description: String que representa o tipo de objeto exportado.
        overrideAssociatedObjectsPerDefinitionPerRowLimit:
          type: boolean
          description: >-
            Booleano que indica se o limite de objetos associados por definição
            por linha deve ser substituído.
        publicCrmSearchRequest:
          $ref: '#/components/schemas/PublicCrmSearchRequest'
      x-hubspot-sub-type-impl: true
    PublicExportListRequest:
      required:
        - associatedObjectType
        - exportInternalValuesOptions
        - exportName
        - exportType
        - format
        - includeLabeledAssociations
        - includePrimaryDisplayPropertyForAssociatedObjects
        - language
        - listId
        - objectProperties
        - objectType
        - overrideAssociatedObjectsPerDefinitionPerRowLimit
      type: object
      properties:
        associatedObjectType:
          type: array
          description: >-
            Matriz de strings que especifica tipos de objetos associados a serem
            incluídos na exportação.
          items:
            type: string
        exportInternalValuesOptions:
          type: array
          description: >-
            Matriz de strings que indica opções para exportar valores internos.
            Valores válidos são "NAMES" e "VALUES".
          items:
            type: string
            enum:
              - NAMES
              - VALUES
        exportName:
          type: string
          description: String que representa o nome da exportação.
        exportType:
          type: string
          description: Uma string que indica o tipo de exportação, que é 'LIST' por padrão.
          default: LIST
          enum:
            - LIST
        format:
          type: string
          description: >-
            String que especifica o formato do arquivo de exportação. Valores
            válidos são "XLS", "XLSX" e "CSV".
          enum:
            - CSV
            - XLS
            - XLSX
        includeLabeledAssociations:
          type: boolean
          description: >-
            Booleano que indica se associações rotuladas devem ser incluídas na
            exportação.
        includePrimaryDisplayPropertyForAssociatedObjects:
          type: boolean
          description: >-
            Booleano que indica se a propriedade de exibição principal para
            objetos associados deve ser incluída.
        language:
          type: string
          description: >-
            String que especifica o idioma para exportação. Valores válidos
            incluem códigos de idioma como "EN", "FR", "DE", etc.
          enum:
            - AF_ZA
            - AR_EG
            - BG
            - BN
            - CA_ES
            - CS
            - DA_DK
            - DE
            - EL_GR
            - EN
            - EN_GB
            - ES
            - ES_MX
            - ET_EE
            - FI
            - FR
            - FR_CA
            - HE_IL
            - HI_IN
            - HR
            - HU
            - ID
            - IT
            - JA
            - KO_KR
            - LT_LT
            - MS
            - NL
            - 'NO'
            - PL
            - PT_BR
            - PT_PT
            - RO
            - RU
            - SK_SK
            - SL
            - SV
            - TH
            - TL
            - TR
            - UK
            - VI_VN
            - ZH_CN
            - ZH_HK
            - ZH_TW
        listId:
          type: string
          description: Uma string que representa o ID da lista a ser exportada.
        objectProperties:
          type: array
          description: >-
            Matriz de strings listando as propriedades dos objetos a serem
            incluídos na exportação.
          items:
            type: string
        objectType:
          type: string
          description: >-
            Uma string que representa o tipo de objetos que estão sendo
            exportados.
        overrideAssociatedObjectsPerDefinitionPerRowLimit:
          type: boolean
          description: >-
            Booleano que indica se o limite em objetos associados por definição
            por linha deve ser substituído.
      x-hubspot-sub-type-impl: true
    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
    PublicCrmSearchRequest:
      required:
        - filterGroups
        - filters
        - sorts
      type: object
      properties:
        filterGroups:
          type: array
          description: >-
            Matriz de grupos de filtros, em que cada grupo contém vários
            filtros. Permite uma lógica de filtragem complexa combinando vários
            filtros.
          items:
            $ref: '#/components/schemas/FilterGroup'
        filters:
          type: array
          description: >-
            Matriz de objetos de filtro usada para especificar os critérios da
            pesquisa. Cada filtro define uma propriedade, um operador e um valor
            para filtrar.
          items:
            $ref: '#/components/schemas/Filter'
        query:
          type: string
          description: >-
            A string de consulta de pesquisa usada para filtrar registros do
            CRM.
        sorts:
          type: array
          description: Define a ordem em que os registros do CRM devem ser retornados.
          items:
            type: string
    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.
    FilterGroup:
      required:
        - filters
      type: object
      properties:
        filters:
          type: array
          description: >-
            Matriz de objetos de filtro que definem critérios para o grupo de
            filtros. Cada filtro especifica uma propriedade, um operador e um
            valor a serem usados no processo de filtragem.
          items:
            $ref: '#/components/schemas/Filter'
      description: >-
        Representa um grupo de filtros usados para consultar dados no HubSpot.
        Este componente é usado para definir critérios de filtragem de registros
        em vários endpoints de API.
    Filter:
      required:
        - operator
        - propertyName
      type: object
      properties:
        highValue:
          type: string
          description: >-
            String que representa valor limite superior usado com o operador
            'BETWEEN'.
        operator:
          type: string
          description: >-
            Operador usado para comparar o valor da propriedade com os valores
            especificados. Operadores válidos incluem "EQ", "NEQ", "LT", "LTE",
            "GT", "GTE", "BETWEEN", "IN", "NOT_IN", "HAS_PROPERTY",
            "NOT_HAS_PROPERTY", "CONTAINS_TOKEN" e "NOT_CONTAINS_TOKEN".
          enum:
            - BETWEEN
            - CONTAINS_TOKEN
            - EQ
            - GT
            - GTE
            - HAS_PROPERTY
            - IN
            - LT
            - LTE
            - NEQ
            - NOT_CONTAINS_TOKEN
            - NOT_HAS_PROPERTY
            - NOT_IN
        propertyName:
          type: string
          description: Nome da propriedade para filtrar. É um valor de string.
        value:
          type: string
          description: >-
            String que representa valor com o qual a propriedade será comparada
            usando determinados operadores.
        values:
          type: array
          description: >-
            Matriz de valores de string usada com operadores como "IN" e
            "NOT_IN" para especificar vários valores de comparação.
          items:
            type: string
      description: >-
        Defines a single condition for searching CRM objects, specifying the
        property to filter on, the operator to use (such as equals, greater
        than, or contains), and the value(s) to compare against. 
  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:
            crm.export: ''

````