Sign in
Campaigns

List campaigns

Paginated list of the shop's creator campaigns with status/type filters and sortable columns. Returns counts per status tab (all/active/past/draft) and per type (retainer/challenge/leaderboard).

get/campaigns

Query parameters

pageinteger
page_sizeinteger
statusstring nullable

UI alias: 'active' (= published), 'past' (= ended), 'draft' (= unpublished drafts), or 'archived'.

UI alias: 'active' (= published), 'past' (= ended), 'draft' (= unpublished drafts), or 'archived'.

campaign_type'retainer' | 'challenge' | 'leaderboard' | 'live_gmv_challenge' | 'race' | 'bingo' | 'sweepstakes'

Supported campaign types.

Filter: retainer | challenge | leaderboard | live_gmv_challenge. Race, Bingo and Sweepstakes are not exposed through this API yet.

searchstring nullable
date_fromstring nullable

YYYY-MM-DD; start_date >= date_from

YYYY-MM-DD; start_date >= date_from

date_tostring nullable

YYYY-MM-DD; end_date <= date_to

YYYY-MM-DD; end_date <= date_to

sort_bystring nullable

campaign_name | campaign_type | gmv | start_date | end_date | total_posts | total_views | created_at

campaign_name | campaign_type | gmv | start_date | end_date | total_posts | total_views | created_at

sort_orderstring

Response

Successful Response

{"stackTrail":"paths:/campaigns:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 1 revision of this API.