Batch

Retrieve batch workflow ID mappings.

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/v4/2027-03-beta/workflow-id-mappings/batch/read

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/automation/v4/2027-03-beta/workflow-id-mappings/batch/read
  • Auth
    OAuth 2
    Authorization code: https://app.hubspot.com/oauth/authorize
    Token URL: https://api.hubapi.com/oauth/v1/token scopes: automation

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

No recorded changes to this operation across all 7 revisions of this API.