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

List campaigns

Get campaigns for given filters

Rate Limit: 1000 Max attempts within 1 minute.

Path Parameters

ParameterDetails
shopKey
  • required
string
Example:
ms

Query Parameters

ParameterDetails
limit
  • Minimum: 1
  • Maximum: 1000
integer
Default:
100
filters[id]
Array of integers
integer
filters[minId]
integer
filters[maxId]
integer
sort
string
Enum:
id
Default:
id
sortDir
string
Enum:
asc
desc
Default:
asc
cursor
string
with
Array of strings
string
Enum:
customData

Responses

200
List of campaigns
application/json
Success
Array of object
object
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
GET/shops/{shopKey}/campaigns

Request samples

Response samples

200
Campaign Collection:
Content type: application/json
Provide Feedback