REreacherapp
Campaigns

List campaigns

Changed on

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

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/campaigns
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Query parameters

pageinteger
page_sizeinteger
statusstring nullable

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

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

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

date_tostring nullable

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

sort_orderstring

Response

Successful Response

unknown required

Changes

  • ecdbfe30e4b8Revision changes
    • info

      added the enum value commission_boost to the property anyOf[subschema #1: CampaignType]/ of the query request parameter campaign_type

  • 291230805105Revision changes
    • info

      api operation id list_campaigns_campaigns_get removed and replaced with campaigns_list