Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

imageSize
string
required

The image size in WxH format that will determine which image to use in each of the returned campaigns

limit
integer<int32>
default:50

The maximum number of results to return

page
integer<int32>
default:1

The page number to return given the limit

sortKey
enum<string>
default:startDate

The key to sort the results by

Available options:
startDate,
endDate,
publishByDate,
brand
sortOrder
enum<string>
default:asc

The order to sort the results by

Available options:
asc,
desc

A search term to filter the results by. Fields that will not be included in search; imageUrl. All other fields will be included in the search. For searching dates, use the format YYYY-MM-DD

type
enum<string>[]

An array of types to filter the results by. If not provided, all types will be returned.

Available options:
Sales,
Events,
New Arrivals,
Loyalty

Response

A list of marketing campaigns for your given location

ok
boolean

Indicates if the request was successful

message
string

A message describing the result of the request

statusCode
integer

The status code of the response

languages
string[]

An array of languages that the campaigns are available in. Note, some languages may not have translations

types
string[]

An array of campaign types that are in the returned results. Note, these may only include a subset of the types available or that were requested in the query

pagination
object

Information about the pagination of the results returned

data
object[]

The list of marketing campaigns