---
title: "Retrieve batch workflow ID mappings."
method: POST
path: "/automation/2026-09-beta/workflow-id-mappings/batch/read"
tags: ["Batch"]
---

# Retrieve batch workflow ID mappings.

`POST /automation/2026-09-beta/workflow-id-mappings/batch/read`

## Request

- Base URL: `https://api.hubapi.com`
- URL: `https://api.hubapi.com/automation/2026-09-beta/workflow-id-mappings/batch/read`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://app.hubspot.com/oauth/authorize`
    - Token URL: `https://api.hubapi.com/oauth/v1/token` scopes: `automation`
  - OAuth 2
    - Authorization code: `https://app.hubspot.com/oauth/authorize`
    - Token URL: `https://api.hubapi.com/oauth/v1/token` scopes: `workflows.write`
  - OAuth 2
    - Authorization code: `https://app.hubspot.com/oauth/authorize`
    - Token URL: `https://api.hubapi.com/oauth/v1/token` scopes: `workflows.delete`
  - OAuth 2
    - Authorization code: `https://app.hubspot.com/oauth/authorize`
    - Token URL: `https://api.hubapi.com/oauth/v1/token` scopes: `workflows.read`

Retrieve batch workflow ID mappings for automation flows. This endpoint allows you to submit a batch request to read multiple workflow ID mappings in one operation, facilitating efficient data retrieval for large sets of automation flows.

## Request body

- ApiFlowBatchMigrationInput
  - `inputs` union[], required
    - union
      - ApiFlowBatchFetchMigrationFlowIdCoordinate
        - `flowId` string
        - `type` 'FLOW_ID', required: Specifies the type of coordinate, which defaults to FLOW_ID.
      - ApiFlowBatchFetchMigrationWorkflowIdCoordinate
        - `type` 'WORKFLOW_ID', required: Specifies the type of coordinate, which defaults to WORKFLOW_ID.
        - `workflowId` string

## Response `200`

successful operation

- BatchResponseFlowIdWorkflowIdMappingResponse
  - `completedAt` string, date-time, required: The date and time when the batch process was completed, formatted as a date-time string.
  - `links` object: A collection of URLs related to the batch process.
  - `requestedAt` string, date-time: The date and time when the batch request was initiated, formatted as a date-time string.
  - `results` FlowIdWorkflowIdMappingResponse[], required
    - `flowId` integer, required: The unique identifier for the flow associated with the workflow.
    - `workflowId` integer, required: The unique identifier for the workflow associated with the flow.
  - `startedAt` string, date-time, required: The date and time when the batch process began, formatted as a date-time string.
  - `status` 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING', required: The current status of the batch process, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.

## Other responses

- `207`: multiple statuses
- `default`: An error occurred.

## Changes

> 98 revisions in range; 5 not diffed.

- **2026-11-13** (2026-09-beta) `6ee0f25fe1ee`: 2 info
  - the security scope `automation` was added to the endpoint's security scheme `oauth2`
  - the security scope `workflows.read` was removed from the endpoint's security scheme `oauth2`
- **2026-07-13** (2026-09-beta) `437ab7f7961c`: 1 info
  - endpoint added
- **2026-07-13** (2026-09-beta) `614f5ff8daff`: 1 breaking
  - api path removed without deprecation
- **2026-05-22** (2026-09-beta) `c0e43a548369`: 3 info
  - the security scope `automation` was added to the endpoint's security scheme `oauth2`
  - the security scope `workflows-access` was removed from the endpoint's security scheme `oauth2`
  - the security scope `workflows-access-public-api` was removed from the endpoint's security scheme `oauth2`
- **2026-05-20** (2026-09-beta) `03fb9d502442`: 2 breaking
  - removed the enum value `FLOW_ID` of the request property `inputs/items/oneOf[subschema #2: WORKFLOW_ID]/type`
  - removed the enum value `WORKFLOW_ID` of the request property `inputs/items/oneOf[subschema #1: FLOW_ID]/type`

[Operation history](https://skmtc.dev/hubspot/apis/automation-automation-v4/changes/automation/2026-09-beta/workflow-id-mappings/batch/read/post.md)

---

[API](https://skmtc.dev/hubspot/apis/automation-automation-v4.md) - [All operations](https://skmtc.dev/hubspot/apis/automation-automation-v4/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/automation-automation-v4/revisions/6ee0f25fe1ee?raw)