> ## 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 contact IDs

> Busque a lista de IDs de contato para a campanha e o tipo de contato especificados. Este endpoint permite recuperar informações de contato associadas a uma campanha específica, filtradas pelo tipo de contato. Ele oferece suporte à paginação e filtragem por data para gerenciar grandes conjuntos de dados de forma eficaz.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-09/marketing-campaigns-public-api-v2026-09.json GET /marketing/campaigns/2026-09/{campaignGuid}/reports/contacts/{contactType}
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/{campaignGuid}/reports/contacts/{contactType}:
    get:
      tags:
        - Reports
      summary: Recuperar IDs de contato
      description: >-
        Busque a lista de IDs de contato para a campanha e o tipo de contato
        especificados. Este endpoint permite recuperar informações de contato
        associadas a uma campanha específica, filtradas pelo tipo de contato.
        Ele oferece suporte à paginação e filtragem por data para gerenciar
        grandes conjuntos de dados de forma eficaz.
      operationId: >-
        get-/marketing/campaigns/2026-09/{campaignGuid}/reports/contacts/{contactType}
      parameters:
        - name: campaignGuid
          in: path
          description: O identificador exclusivo da campanha.
          required: true
          style: simple
          explode: false
          schema:
            type: string
        - name: contactType
          in: path
          description: O tipo de contato para filtrar a lista.
          required: true
          style: simple
          explode: false
          schema:
            type: string
        - name: after
          in: query
          description: >-
            Um token de cursor para paginação. Use o valor do campo
            paging.next.after da resposta anterior.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: endDate
          in: query
          description: >-
            A data de término para filtrar dados de contato, formatada como
            AAAA-MM-DD.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: limit
          in: query
          description: O número máximo de resultados a serem exibidos por página.
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int32
        - name: startDate
          in: query
          description: >-
            A data de início para filtrar dados de contato, formatada como
            AAAA-MM-DD.
          required: false
          style: form
          explode: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CollectionResponseContactReferenceForwardPaging
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - marketing.campaigns.read
components:
  schemas:
    CollectionResponseContactReferenceForwardPaging:
      required:
        - results
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/ForwardPaging'
        results:
          type: array
          description: >-
            Uma matriz de referências de contato, cada uma representando um
            contato associado à campanha. Cada item na matriz é um objeto
            ContactReference.
          items:
            $ref: '#/components/schemas/ContactReference'
    ForwardPaging:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/NextPage'
      description: >-
        Informações de paginação para paginação somente para frente. Contém a
        referência da próxima página quando há mais resultados disponíveis; é
        omitida ou fica vazia na última página.
    ContactReference:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          description: >-
            O identificador exclusivo para a referência do contato, representado
            como uma string.
    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
    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
    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.
  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: ''

````