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

# Batch retrieve campaigns

> Obtenha um lote de campanhas usando os parâmetros especificados. Este endpoint permite filtrar campanhas por período e selecionar propriedades específicas para incluir na resposta. É útil para obter informações detalhadas sobre várias campanhas de uma só vez.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-09/marketing-campaigns-public-api-v2026-09.json POST /marketing/campaigns/2026-09/batch/read
openapi: 3.0.1
info:
  title: Marketing Campaigns Public Api
  description: Basepom for all HubSpot Projects
  version: 2026-09
  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: Assets
  - name: Basic
  - name: Batch
  - name: Budget
  - name: Reports
  - name: Spend
paths:
  /marketing/campaigns/2026-09/batch/read:
    post:
      tags:
        - Batch
      summary: Recuperar campanhas em lote
      description: >-
        Obtenha um lote de campanhas usando os parâmetros especificados. Este
        endpoint permite filtrar campanhas por período e selecionar propriedades
        específicas para incluir na resposta. É útil para obter informações
        detalhadas sobre várias campanhas de uma só vez.
      operationId: post-/marketing/campaigns/2026-09/batch/read
      parameters:
        - name: endDate
          in: query
          description: A data final para filtrar campanhas, formatada como uma string.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: properties
          in: query
          description: >-
            Uma lista de nomes de propriedades separados por vírgulas para
            incluir na resposta.
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: startDate
          in: query
          description: A data de início para filtrar campanhas, formatada como uma string.
          required: false
          style: form
          explode: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchInputPublicCampaignReadInput'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResponsePublicCampaignWithAssets'
        '207':
          description: multiple statuses
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BatchResponsePublicCampaignWithAssetsWithErrors
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - marketing.campaigns.read
components:
  schemas:
    BatchInputPublicCampaignReadInput:
      required:
        - inputs
      type: object
      properties:
        inputs:
          type: array
          description: >-
            Uma matriz de objetos PublicCampaignReadInput, cada um contendo o ID
            de uma campanha a ser lida. Esta propriedade é obrigatória.
          items:
            $ref: '#/components/schemas/PublicCampaignReadInput'
    BatchResponsePublicCampaignWithAssets:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: >-
            A data e hora em que a operação em lote foi concluída, no formato
            ISO 8601.
          format: date-time
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associadas, fornecendo recursos
            adicionais ou documentação relacionada à operação em lote.
        requestedAt:
          type: string
          description: >-
            A data e a hora em que a operação em lote foi solicitada, no formato
            ISO 8601.
          format: date-time
        results:
          type: array
          description: >-
            Uma matriz de objetos PublicCampaignWithAssets, representando as
            campanhas envolvidas na operação em lote.
          items:
            $ref: '#/components/schemas/PublicCampaignWithAssets'
        startedAt:
          type: string
          description: >-
            A data e a hora em que a operação em lote foi iniciada, no formato
            ISO 8601.
          format: date-time
        status:
          type: string
          description: >-
            O status atual da operação em lote. Os valores válidos incluem
            'PENDENTE', 'PROCESSANDO', 'CANCELADO' e 'CONCLUÍDO'.
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    BatchResponsePublicCampaignWithAssetsWithErrors:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: >-
            A data e hora em que a operação em lote foi concluída, no formato
            ISO 8601.
          format: date-time
        errors:
          type: array
          description: >-
            Uma matriz de erros que ocorreram durante a operação em lote, cada
            um descrito por um objeto de erro padrão.
          items:
            $ref: '#/components/schemas/StandardError'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associadas que fornecem
            informações adicionais sobre a operação em lote.
        numErrors:
          type: integer
          description: O número de erros que ocorreram durante a operação em lote.
          format: int32
        requestedAt:
          type: string
          description: >-
            A data e a hora em que a operação em lote foi solicitada, no formato
            ISO 8601.
          format: date-time
        results:
          type: array
          description: >-
            Uma matriz de campanhas com seus ativos associados que foram
            processados na operação em lote.
          items:
            $ref: '#/components/schemas/PublicCampaignWithAssets'
        startedAt:
          type: string
          description: >-
            A data e a hora em que a operação em lote foi iniciada, no formato
            ISO 8601.
          format: date-time
        status:
          type: string
          description: >-
            O status atual da operação em lote. Os valores válidos incluem
            'PENDENTE', 'PROCESSANDO', 'CANCELADO' e 'CONCLUÍDO'.
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    PublicCampaignReadInput:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          description: >-
            O identificador exclusivo da campanha. É uma string e é necessário
            para recuperar os detalhes da campanha.
    PublicCampaignWithAssets:
      required:
        - assets
        - businessUnits
        - createdAt
        - id
        - properties
        - updatedAt
      type: object
      properties:
        assets:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CollectionResponsePublicCampaignAsset'
          description: >-
            Um mapa de tipos de ativos para seus respectivos conjuntos de ativos
            de campanha, representados por objetos
            CollectionResponsePublicCampaignAsset.
        businessUnits:
          type: array
          description: >-
            Uma matriz de unidades de negócios associadas à campanha, cada uma
            representada por um objeto PublicBusinessUnit.
          items:
            $ref: '#/components/schemas/PublicBusinessUnit'
        createdAt:
          type: string
          description: A data e hora em que a campanha foi criada, no formato ISO 8601.
          format: date-time
        id:
          type: string
          description: O identificador exclusivo da campanha, representado como uma string.
        properties:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de propriedades personalizadas para seus valores,
            onde cada valor é uma string.
        updatedAt:
          type: string
          description: >-
            A data e a hora da última atualização da campanha, no formato ISO
            8601.
          format: date-time
    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 inclui contexto adicional sobre o 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 de um erro.
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um objeto que mapeia nomes de links para URIs associadas que contêm
            documentação ou etapas de correção relacionadas ao erro.
        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
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria do erro, representada como uma string.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Um objeto que fornece contexto sobre a condição de erro, em que cada
            chave é uma string e cada valor é uma matriz de strings.
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação, formatado como um
            UUID. Deve ser incluído em todos os relatórios de erro ou tickets de
            suporte.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: >-
            Uma matriz que fornece mais informações sobre o erro, com cada item
            sendo um objeto ErrorDetail.
          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 etapas de correção recomendadas,
            representado como um objeto com valores de string.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado. É uma string.
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém detalhes mais específicos sobre
            o erro, representada como uma string.
      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
    CollectionResponsePublicCampaignAsset:
      required:
        - results
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          description: >-
            Uma matriz de objetos PublicCampaignAsset, cada um representando um
            ativo de campanha individual.
          items:
            $ref: '#/components/schemas/PublicCampaignAsset'
    PublicBusinessUnit:
      required:
        - id
      type: object
      properties:
        id:
          type: integer
          description: >-
            O identificador exclusivo da unidade de negócio, representado como
            um número inteiro de 64 bits.
          format: int64
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: O código de status associado ao detalhe do erro. É uma string.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Contexto sobre a condição de erro, fornecido como um objeto em que
            cada chave é um nome de contexto e o valor é uma matriz de strings
            que fornecem informações adicionais.
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: >-
            O nome do campo ou parâmetro no qual o erro foi encontrado. É uma
            string.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado. Esta é uma string.
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém detalhes mais específicos sobre
            o erro. Esta é uma string.
      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.
    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.
    PublicCampaignAsset:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          description: >-
            O identificador exclusivo do ativo da campanha, representado como
            uma string.
        metrics:
          type: object
          additionalProperties:
            type: number
          description: >-
            Um conjunto de métricas de desempenho para o ativo da campanha,
            representada como um mapa em que cada chave é um nome de métrica e
            cada valor é um número.
        name:
          type: string
          description: O nome do ativo da campanha, representado como uma string.
    NextPage:
      required:
        - after
      type: object
      properties:
        after:
          type: string
          description: >-
            Um token de string que serve como cursor de paginação, indicando a
            posição após o último recurso lido com sucesso.
        link:
          type: string
          description: >-
            Um URL de string que fornece um link para a próxima página de
            resultados.
      description: >-
        Specifies the paging information needed to retrieve the next set of
        results in a paginated API response
    PreviousPage:
      required:
        - before
      type: object
      properties:
        before:
          type: string
          description: >-
            Um token de string usado para identificar a posição antes da página
            atual nos resultados paginados.
        link:
          type: string
          description: >-
            Uma string de URL que fornece um link para a página de resultados
            anterior.
      description: >-
        specifies the paging information needed to retrieve the previous set of
        results in a paginated API response
  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:
            marketing.campaigns.read: ''
            marketing.campaigns.revenue.full.read: ''
            marketing.campaigns.revenue.lite.read: ''
            marketing.campaigns.revenue.read: ''
            marketing.campaigns.write: ''

````