> ## 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 workflow email campaigns

> Recupere uma lista de campanhas de e-mail associadas a fluxos de automação, com paginação opcional usando os parâmetros de consulta "after", "before" e "limit".

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v4/automation-automation-v4-v4.json GET /automation/v4/flows/email-campaigns
openapi: 3.0.1
info:
  title: Automation Automation V4
  description: Basepom for all HubSpot Projects
  version: v4
  x-hubspot-product-tier-requirements:
    marketing: PROFESSIONAL
    sales: PROFESSIONAL
    service: PROFESSIONAL
    cms: PROFESSIONAL
    commerce: PROFESSIONAL
    crmHub: PROFESSIONAL
    dataHub: PROFESSIONAL
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
  - name: Batch
paths:
  /automation/v4/flows/email-campaigns:
    get:
      tags:
        - Basic
      summary: Recuperar campanhas de e-mail de fluxo de trabalho
      description: >-
        Recupere uma lista de campanhas de e-mail associadas a fluxos de
        automação, com paginação opcional usando os parâmetros de consulta
        "after", "before" e "limit".
      operationId: get-/automation/v4/flows/email-campaigns
      parameters:
        - name: after
          in: query
          description: >-
            O token do cursor de paginação do último recurso lido com sucesso
            será retornado como a propriedade JSON "paging.next.after" de uma
            resposta paginada que contém mais resultados.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: before
          in: query
          description: ''
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: flowId
          in: query
          description: ''
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              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
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseApiFlowEmailCampaign'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - automation
components:
  schemas:
    CollectionResponseApiFlowEmailCampaign:
      required:
        - results
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          items:
            $ref: '#/components/schemas/ApiFlowEmailCampaign'
    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.
    ApiFlowEmailCampaign:
      required:
        - emailCampaignId
        - emailContentId
        - flowId
      type: object
      properties:
        emailCampaignId:
          type: string
          description: >-
            O identificador exclusivo da campanha de e-mail associada ao fluxo
            de automação.
        emailContentId:
          type: string
          description: >-
            O identificador exclusivo do conteúdo do e-mail usado na campanha de
            e-mail.
        flowId:
          type: string
          description: >-
            O identificador exclusivo do fluxo de automação associado à campanha
            de e-mail.
    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: Um token de cursor de paginação para recuperar páginas subsequentes.
        link:
          type: string
          description: >-
            Um URL que pode ser usado para recuperar os resultados da próxima
            página.
      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: Um token de cursor de paginação para recuperar páginas anteriores.
        link:
          type: string
          description: >-
            Um URL que pode ser usado para recuperar os resultados das páginas
            anteriores.
      description: >-
        especifica as informações de paginação necessárias para recuperar o
        conjunto anterior de resultados em uma resposta de API paginada
    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:
            automation: ''

````