GET
/
show
curl --request GET \
  --url https://firstpromoter.com/api/v1/promoters/show \
  --header 'X-API-KEY: <api-key>'
{
  "id": 123,
  "status": "approved",
  "cust_id": "<string>",
  "email": "<string>",
  "created_at": "<string>",
  "temp_password": "<string>",
  "default_promotion_id": 128833,
  "pref": "<string>",
  "default_ref_id": "<string>",
  "note": "<string>",
  "w8_form_url": "<string>",
  "w9_form_url": "<string>",
  "parent_promoter_id": "<string>",
  "earnings_balance": {
    "cash": 3000,
    "credits": 300,
    "discount_per": 30
  },
  "current_balance": {
    "cash": 1000,
    "credits": 200,
    "discount_per": 15
  },
  "paid_balance": {
    "cash": 2000,
    "credits": 100,
    "discount_per": 15
  },
  "auth_token": "<string>",
  "profile": {
    "first_name": "<string>",
    "last_name": "<string>",
    "website": "<string>",
    "company_name": "<string>",
    "phone_number": "<string>",
    "address": "<string>",
    "vat_id": "<string>",
    "country": "<string>",
    "paypal_email": "<string>",
    "avatar_url": "<string>",
    "description": "<string>",
    "social_accounts": {
      "twitter": {
        "url": "<string>"
      },
      "youtube": {
        "url": "<string>"
      },
      "facebook": {
        "url": "<string>"
      },
      "linkedin": {
        "url": "<string>"
      },
      "instagram": {
        "url": "<string>"
      }
    }
  },
  "promotions": [
    {
      "id": 123,
      "status": "<string>",
      "ref_id": "<string>",
      "promo_code": "<string>",
      "customer_promo_code": "<string>",
      "target_reached_at": {},
      "promoter_id": 123,
      "campaign_id": 123,
      "referral_link": "<string>",
      "current_offer": {
        "id": 123,
        "name": "<string>",
        "amount": 123,
        "unit": "<string>",
        "default_promo_code": "<string>"
      },
      "current_referral_reward": {
        "id": 123,
        "amount": 123,
        "unit": "<string>",
        "name": "<string>",
        "per_of_sale": 123,
        "default_promo_code": "<string>"
      },
      "current_promotion_reward": {},
      "current_target_reward": {},
      "campaign_name": "<string>",
      "hidden": true,
      "visitors_count": 123,
      "leads_count": 123,
      "customers_count": 123,
      "refunds_count": 123,
      "cancellations_count": 123,
      "sales_count": 123,
      "sales_total": 123,
      "refunds_total": 123,
      "active_customers_count": 123
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
id
string

required if promoter_email, ref_id, auth_token or cust_id is null

`The promoter's ID inside FirstPromoter

​
promoter_email
string

required if id, ref_id, auth_token or cust_id is null

The promoter's email

​
cust_id
string

required if id, ref_id, auth_token or promoter_email is null

Your customer's user ID inside your application/system for the promoter.

​
ref_id
string

required if the promoter_email,auth_token, id or cust_id is null

Referral ID.

​
auth_token
string

required if the promoter_email, id, ref_id or cust_id is null

Authentication token generated when the promoter was created

Response

200
application/json

Show promoters response

The response is of type object.