Skip to main content
GET
/
list
cURL
curl --request GET \
  --url https://firstpromoter.com/api/v1/leads/list \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": 123,
    "state": "signup",
    "uid": "<unknown>",
    "email": "[email protected]",
    "customer_since": "<string>",
    "cancelled_at": "<string>",
    "plan_name": "<string>",
    "suspicion": "<string>",
    "username": "<string>",
    "website": "<string>",
    "created_at": "<string>",
    "split_promotion_id": "<unknown>",
    "custom_fields": "<unknown>",
    "split_percentage_value": "<unknown>",
    "visitor_sub_id": "<unknown>",
    "promotion": {
      "id": 123,
      "status": "<string>",
      "ref_id": "<string>",
      "promo_code": "<string>",
      "customer_promo_code": "<string>",
      "target_reached_at": "<string>",
      "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
    },
    "promoter": {
      "id": 123,
      "status": "approved",
      "cust_id": "<unknown>",
      "email": "<string>",
      "created_at": "<string>",
      "temp_password": "<string>",
      "default_promotion_id": 123,
      "pref": "<string>",
      "default_ref_id": "<string>",
      "note": "<string>",
      "w8_form_url": "<unknown>",
      "w9_form_url": "<unknown>",
      "parent_promoter_id": "<string>",
      "earnings_balance": {},
      "current_balance": {},
      "paid_balance": {},
      "auth_token": "<string>"
    }
  }
]

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
promotion_id
string

List all leads and customer assigned to this promotion id

​
ref_id
string

List all leads and customer assigned to a promotion - find promotion by ref_id

​
promoter_id
string

List all leads and customers assigned to a promoter

​
campaign_id
string

List all leads and customers in a campaign

Response

Get the list of leads and customers response

​
id
integer

The lead's ID inside FirstPromoter

​
state
enum<string>

The lead's or customer's status

Available options:
signup,
active,
subscribed,
denied,
cancelled
​
uid
any

Your lead/customer's user ID inside your application.

​
email
string<email>

The lead's or customer's email

​
customer_since
string

ISO date string at which the lead converted to a customer.

​
cancelled_at
string

ISO date string at which the lead/customer cancelled

​
plan_name
string
​
suspicion
string
​
username
string
​
website
string
​
created_at
string

ISO date string at which the lead/customer signed up

​
split_promotion_id
any
​
custom_fields
any
​
split_percentage_value
any
​
visitor_sub_id
any
​
promotion
object
​
promoter
object