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

from
string
required

Starting record index, starting from 0

to
string
required

Ending record index, starting from 0

type
enum<string>

Filter by campaign type The campaign type

Available options:
BEHAVIOR,
COUPONS,
PUNCH_CARDS,
REFERRALS,
SCORE_STREAKS
brand_id
string<uuid> | null

Filter by brand id

customer_id
string

Filter campaigns that a customer can participate

status
enum<string>

Filter by campaign status

Available options:
RUNNING,
PAUSED,
SCHEDULED,
FINISHED,
NOT FINISHED
labels
string

Filter by campaign labels (, separated values)

platform
string

Filter by platform name

store_id
string

Filter by store id. Campaigns with stores = null are included because they have no store restriction; campaigns with a non-empty stores array are included only when it contains this id; campaigns with stores = [] are excluded.

channel_id
string

Filter by channel id. Campaigns with channels = null are included because they have no channel restriction; campaigns with a non-empty channels array are included only when it contains this id; campaigns with channels = [] are excluded.

product_id
string

Filter by product id. Campaigns with products = null are included because they have no product restriction; campaigns with a non-empty products array are included only when it contains this id; campaigns with products = [] are excluded.

funded_by
string

Filter by funder

includes
enum<string>

Whether to include additional data inside attributes Only applies to COUPONS campaigns

Available options:
CODES_SUMMARY

Response

200 - application/json

Ok

data
object[]
from
number

The starting record index

Example:

0

to
number

The ending record index

Example:

9

count
number

The total number of campaigns

Example:

10