HUhubspot
Batch

Retrieve batch workflow ID mappings.

Changed on

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.

post/automation/2026-09-beta/workflow-id-mappings/batch/read

Request

  • Base URL
    https://api.hubapi.com
  • Auth
    • OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopesautomation
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopesworkflows.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopesworkflows.delete
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopesworkflows.read

Request body

Response

successful operation

completedAtstring date-time required

The date and time when the batch process was completed, formatted as a date-time string.

linksobject

A collection of URLs related to the batch process.

requestedAtstring date-time

The date and time when the batch request was initiated, formatted as a date-time string.

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

Changes

  • 2026-09-beta6ee0f25fe1eeRevision changes
    • info

      the security scope automation was added to the endpoint's security scheme oauth2

    • info

      the security scope workflows.read was removed from the endpoint's security scheme oauth2

  • 2026-09-beta437ab7f7961cRevision changes
    • info

      endpoint added