Sign in

v1

latestOpenAPI 3.0.02026-07-264731126.7 KB
Referrals

Get available referrals

Get available referrals <Tip>HTTP Request <br/>GET https://api.firstpromoter.com/api/v2/company/referrals</Tip>

get/referrals

Query parameters

qstring

Search params. Searches by email, uid, username, website

ids[]integer[]

Array of referral ids to get

filters[type]'lead' | 'customer'

Filter the referrals by type (lead or customer)

filters[promoter_id]string

Filter the referrals by a promoter id

filters[state]'subscribed' | 'signup' | 'active' | 'cancelled' | 'refunded' | 'denied' | 'pending' | 'moved'

Filter the referrals by state

filters[customer_since][from]string date

Filter referrals where customer_since is on or after this date (ISO 8601 format: YYYY-MM-DD)

filters[customer_since][to]string date

Filter referrals where customer_since is on or before this date (ISO 8601 format: YYYY-MM-DD)

filters[created_at][from]string date

Filter referrals created on or after this date (ISO 8601 format: YYYY-MM-DD)

filters[created_at][to]string date

Filter referrals created on or before this date (ISO 8601 format: YYYY-MM-DD)

filters[cancelled_at][from]string date

Filter referrals cancelled on or after this date (ISO 8601 format: YYYY-MM-DD)

filters[cancelled_at][to]string date

Filter referrals cancelled on or before this date (ISO 8601 format: YYYY-MM-DD)

Headers

Account-IDstring required

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

Response

List of referrals

idinteger

Id of the referral

emailstring email

Email address of the referral

uidstring

uid of the referral

state'subscribed' | 'signup' | 'active' | 'cancelled' | 'refunded' | 'denied' | 'pending' | 'moved'

State of the referral

metadataobject

Additional metadata of the referral

entry_source'api' | 'coupon' | 'cookie' | 'manual_admin' | 'manual_affiliate'

Entry source of the referral. This shows where the referral was captured from. Cookie is set if the referral was captured using the tid cookie, Coupon is for when the referral is captured via a coupon code. Manual admin is for when the referral is added manually by an admin. Manual affiliate is for when the referral is added manually by an affiliate.

created_atstring date-time

Date and time when the referral was created

customer_sincestring date-time nullable

Date and time when the referral became a customer

fraud_check'no_suspicion' | 'same_ip_suspicion' | 'same_promoter_email' | 'ad_source'

Fraud check (suspicion) status of the referral. no_suspicion means the referral is clean or was manually cleared. same_ip_suspicion means the referral shares an IP with the promoter. same_promoter_email means the referral email matches the promoter email. ad_source means the referral arrived via a paid ad click.

created_by_user_emailstring email nullable

Email address of the user who created the referral

usernamestring nullable

Username chosen by the referral

first_namestring nullable
last_namestring nullable
websitestring nullable
commentstring nullable

Internal note or comment on this referral

is_expiredboolean

Whether the referral has expired

Example response

[
  {
    "promoter_campaign": {
      "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"
      }
    }
  }
]