Batch

Retrieve multiple automation flows in a single request.

Changed on

Retrieve multiple automation flows in a single request. This endpoint is useful for efficiently fetching data about several flows at once, reducing the need for multiple API calls. It is ideal for applications that need to process or display information about multiple flows simultaneously.

post/automation/2026-09-beta/flows/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, empty for this operation.

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-betabf0e045cbe0fRevision changes
    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status