Batch

Batch retrieve campaigns

Retrieve a batch of campaigns using specified parameters. This endpoint allows you to filter campaigns by date range and select specific properties to include in the response. It is useful for obtaining detailed information about multiple campaigns at once.

post/marketing/campaigns/2026-09/batch/read

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/marketing/campaigns/2026-09/batch/read
  • Auth
    OAuth 2
    Authorization code: https://app.hubspot.com/oauth/authorize
    Token URL: https://api.hubapi.com/oauth/v1/token scopes: marketing.campaigns.read

Query parameters

endDatestring

The end date for filtering campaigns, formatted as a string.

propertiesstring[]

A comma-separated list of property names to include in the response.

startDatestring

The start date for filtering campaigns, formatted as a string.

Request body

Response

successful operation

completedAtstring date-time required

The date and time when the batch operation was completed, in ISO 8601 format.

linksobject

A map of link names to associated URIs, providing additional resources or documentation related to the batch operation.

requestedAtstring date-time

The date and time when the batch operation was requested, in ISO 8601 format.

startedAtstring date-time required

The date and time when the batch operation started, in ISO 8601 format.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.

Changes

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