HUhubspot
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/v4/2027-03-beta/flows/batch/read

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/automation/v4/2027-03-beta/flows/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, 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

  • 2027-03-betaf041eccef172Revision changes
    • breaking

      added to the /////// response property oneOf list for the response status

    • breaking

      added to the /////// response property oneOf list for the response status

    • breaking

      added to the /////// response property oneOf list for the response status

    • breaking

      added to the /////// response property oneOf list for the response status

    • breaking

      added to the ///////// response property oneOf list for the response status

    • breaking

      added to the ///////// response property oneOf list for the response status

    • breaking

      added to the //////////// response property oneOf list for the response status

    • breaking

      added to the //////////// response property oneOf list for the response status

    • breaking

      added to the /////////// response property oneOf list for the response status

    • breaking

      added to the /////////// response property oneOf list for the response status

    • breaking

      added to the ////////////// response property oneOf list for the response status

    • breaking

      added to the ////////////// response property oneOf list for the response status

    • breaking

      added to the /////////// response property oneOf list for the response status

    • breaking

      added to the /////////// response property oneOf list for the response status

    • breaking

      added to the ////////////// response property oneOf list for the response status

    • breaking

      added to the ////////////// response property oneOf list for the response status

    • breaking

      added to the ///////// response property oneOf list for the response status

    • breaking

      added to the ///////// response property oneOf list for the response status

    • breaking

      added to the //////////// response property oneOf list for the response status

    • breaking

      added to the //////////// response property oneOf list for the response status

    • breaking

      added to the /////////// response property oneOf list for the response status

    • breaking

      added to the /////////// response property oneOf list for the response status

    • breaking

      added to the ////////////// response property oneOf list for the response status

    • breaking

      added to the ////////////// response property oneOf list for the response status

    • breaking

      added to the /////////// response property oneOf list for the response status

    • breaking

      added to the /////////// response property oneOf list for the response status

    • breaking

      added to the ////////////// response property oneOf list for the response status

    • breaking

      added to the ////////////// response property oneOf list for the response status

  • 2027-03-betaa8b693066f9eRevision 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