> ## 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 workflow ID mappings

> Obtenha mapeamentos de ID de fluxo de trabalho em lote para fluxos de automação. Este endpoint permite enviar uma solicitação em lote para ler vários mapeamentos de ID de fluxo de trabalho em uma única operação, facilitando a recuperação eficiente de dados para grandes conjuntos de fluxos de automação.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2027-03-beta/automation-automation-v4-v2027-03-beta.json POST /automation/v4/2027-03-beta/workflow-id-mappings/batch/read
openapi: 3.0.1
info:
  title: Automation Automation V4
  description: Basepom for all HubSpot Projects
  version: 2027-03-beta
  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: Advanced
  - name: Basic
  - name: Batch
paths:
  /automation/v4/2027-03-beta/workflow-id-mappings/batch/read:
    post:
      tags:
        - Batch
      summary: Obter mapeamentos de IDs de fluxo de trabalho em lote.
      description: >-
        Obtenha mapeamentos de ID de fluxo de trabalho em lote para fluxos de
        automação. Este endpoint permite enviar uma solicitação em lote para ler
        vários mapeamentos de ID de fluxo de trabalho em uma única operação,
        facilitando a recuperação eficiente de dados para grandes conjuntos de
        fluxos de automação.
      operationId: >-
        post-/automation/v4/2027-03-beta/workflow-id-mappings/batch/read_/automation/v4/2026-09-beta/workflow-id-mappings/batch/read
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiFlowBatchMigrationInput'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BatchResponseFlowIdWorkflowIdMappingResponse
        '207':
          description: multiple statuses
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BatchResponseFlowIdWorkflowIdMappingResponseWithErrors
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - automation
components:
  schemas:
    ApiFlowBatchMigrationInput:
      required:
        - inputs
      type: object
      properties:
        inputs:
          type: array
          items:
            oneOf:
              - $ref: >-
                  #/components/schemas/ApiFlowBatchFetchMigrationFlowIdCoordinate
              - $ref: >-
                  #/components/schemas/ApiFlowBatchFetchMigrationWorkflowIdCoordinate
    BatchResponseFlowIdWorkflowIdMappingResponse:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: >-
            A data e a hora em que o processo em lote foi concluído, formatadas
            como uma string de data e hora.
          format: date-time
        links:
          type: object
          additionalProperties:
            type: string
          description: Um conjunto de URLs relacionados ao processo em lote.
        requestedAt:
          type: string
          description: >-
            A data e a hora em que o processo em lote foi concluído, formatadas
            como uma string de dados e hora.
          format: date-time
        results:
          type: array
          items:
            $ref: '#/components/schemas/FlowIdWorkflowIdMappingResponse'
        startedAt:
          type: string
          description: >-
            A data e a hora em que o processo em lote começou, formatadas como
            uma string de data e hora.
          format: date-time
        status:
          type: string
          description: >-
            O status atual do processo em lote, com os seguintes valores
            possíveis: CANCELADO, CONCLUÍDO, PENDENTE, PROCESSANDO.
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    BatchResponseFlowIdWorkflowIdMappingResponseWithErrors:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          format: date-time
        errors:
          type: array
          items:
            $ref: '#/components/schemas/StandardError'
        links:
          type: object
          additionalProperties:
            type: string
        numErrors:
          type: integer
          format: int32
        requestedAt:
          type: string
          format: date-time
        results:
          type: array
          items:
            $ref: '#/components/schemas/FlowIdWorkflowIdMappingResponse'
        startedAt:
          type: string
          format: date-time
        status:
          type: string
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    ApiFlowBatchFetchMigrationFlowIdCoordinate:
      title: FLOW_ID
      required:
        - type
      type: object
      properties:
        flowId:
          type: string
        type:
          type: string
          description: Especifica o tipo de coordenada, cujo valor padrão é FLOW_ID.
          default: FLOW_ID
          enum:
            - FLOW_ID
      x-hubspot-sub-type-impl: true
    ApiFlowBatchFetchMigrationWorkflowIdCoordinate:
      title: WORKFLOW_ID
      required:
        - type
      type: object
      properties:
        type:
          type: string
          description: Especifica o tipo de coordenada, que por padrão é WORKFLOW_ID.
          default: WORKFLOW_ID
          enum:
            - WORKFLOW_ID
        workflowId:
          type: string
      x-hubspot-sub-type-impl: true
    FlowIdWorkflowIdMappingResponse:
      required:
        - flowId
        - workflowId
      type: object
      properties:
        flowId:
          type: integer
          description: O identificador exclusivo do fluxo associado ao fluxo de trabalho.
          format: int64
        workflowId:
          type: integer
          description: O identificador exclusivo do fluxo de trabalho associado ao fluxo.
          format: int32
    StandardError:
      required:
        - category
        - context
        - errors
        - links
        - message
        - status
      type: object
      properties:
        category:
          type: string
          description: The main category of the error.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Additional context-specific information related to the error.
        errors:
          type: array
          description: The detailed error objects.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        id:
          type: string
          description: A unique ID for the error instance.
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            URLs linking to documentation or resources associated with the
            error.
        message:
          type: string
          description: >-
            A human-readable string describing the error and possible
            remediation steps.
        status:
          type: string
          description: The HTTP status code associated with the error.
        subCategory:
          type: object
          properties: {}
          description: A more specific error category within each main category.
      description: Ye olde error
    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
    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: ''

````