docs
  1. Storefront Api
  2. Resources
  3. Campaigns
  4. List Campaigns

List campaigns

List campaigns

Query Parameters

ParameterDetails
shopId
integer
page
  • Minimum: 1
integer
Default:
1
perPage
  • Minimum: 1
  • Maximum: 1000
integer
Default:
100
offset
  • Maximum: 499000
integer
limit
  • Minimum: 1
  • Maximum: 1000
integer
Default:
100
sortDir
string
Enum:
asc
desc
Default:
asc
sort
string
Enum:
id
reduction
startsAt
endsAt
Default:
id

Header Parameters

ParameterDetails
X-Shop-Id
integer

Responses

200
Operation successful
application/json
Success
required
null
required
Array of object
400
Required parameter is missing or invalid.
application/json
Error
401
Authentication credentials are missing or invalid.
application/json
Error
429
Rate limit was exceeded.
application/json
Error
GET/v1/campaigns

Request samples

Response samples

200
default:
Content type: application/json

Last updated: June 20, 2024

Provide Feedback