GET
/
marketing
/
v3
/
campaigns
/
Campaign search
curl --request GET \
  --url https://api.hubapi.com/marketing/v3/campaigns/ \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "paging": {
    "next": {
      "link": "",
      "after": ""
    }
  },
  "results": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "businessUnits": [
        {
          "id": 123
        }
      ],
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubProfessional
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubFree

​
Required Scopes

This API requires one of the following scopes:
  • marketing.campaigns.read

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
sort
string

The field by which to sort the results. Allowed values are hs_name, createdAt, updatedAt. An optional '-' before the property name can denote descending order Default: hs_name

​
after
string

A cursor for pagination. If provided, the results will start after the given cursor. Example: NTI1Cg%3D%3D

​
limit
integer

The maximum number of results to return. Allowed values range from 1 to 100 Default: 50

​
name
string

A filter to return campaigns whose names contain the specified substring. This allows partial matching of campaign names, returning all campaigns that include the given substring in their name. If this parameter is not provided, the search will return all campaigns

​
properties
string[]

A comma-separated list of the properties to be returned in the response. If any of the specified properties has empty value on the requested object(s), they will be ignored and not returned in response. If this parameter is empty, the response will include an empty properties map

Response

200
application/json

successful operation

The response is of type object.