Skip to main content
POST
/
marketing
/
v3
/
campaigns
/
batch
/
read
Read a batch of campaigns
curl --request POST \
  --url https://api.hubapi.com/marketing/v3/campaigns/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "id": "<string>"
    }
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "assets": {},
      "businessUnits": [
        {
          "id": 123
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "message": "<string>",
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "subCategory": "<string>"
        }
      ],
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "id": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z"
}

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

endDate
string
properties
string[]
startDate
string

Body

application/json
inputs
object[]
required

Response

successful operation

completedAt
string<date-time>
required

The timestamp when the batch request processing was completed.

results
object[]
required
startedAt
string<date-time>
required

The timestamp when the processing of the batch request began.

status
enum<string>
required

The current processing status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.

Available options:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

A collection of URLs linking to related resources or documentation.

numErrors
integer<int32>
requestedAt
string<date-time>

The timestamp when the batch request was initially made.

Last modified on March 30, 2026