v1

latestOpenAPI 3.0.02026-07-264731126.7 KB

Promoter Campaigns

Get available promoter campaigns

With this endpoint you can list all promoter campaigns. <Tip>HTTP Request <br/>GET https://api.firstpromoter.com/api/v2/company/promoter_campaigns</Tip>

get/promoter_campaigns

Headers

Account-IDstring required

Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Response

List of promoter campaigns

idinteger

Id of the promoter campaign

campaign_idinteger

Id of the campaign

promoter_idinteger

Id of the promoter

created_atstring date-time

Date and time when the promoter campaign was created

Example response

[
  {
    "promoter": {
      "id": 3920164,
      "status": "active",
      "email": "peluwydo@mailinator.com",
      "created_at": "2022-04-26T15:28:24.800Z",
      "temp_password": "xxxxxxxxxx",
      "default_promotion_id": 4210919,
      "pref": "db1znwe",
      "default_ref_id": "8yi2epelut",
      "note": "This is a note",
      "parent_promoter_id": 577918,
      "earnings_balance": {
        "cash": 50744
      },
      "current_balance": {
        "cash": 20044
      },
      "paid_balance": {
        "cash": 30700
      },
      "auth_token": "xxxxxxxxxxxxxx"
    }
  }
]