GET
/
show

Authorizations

X-API-KEY
string
headerrequired

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
id
integer

The promoter's ID inside FirstPromoter

status
enum<string>

Promoter's status

Available options:
approved,
pending,
denied
cust_id
string

Your customer's user ID inside your application/system for the promoter. This will be included in the webhook event and can be used to identify the promoter in your system if you scribscibe for FirstPromoter's webhooks.

email
string

Promoter's email

created_at
string

ISO date string when the promoter signed up

temp_password
string

A temporary password the promoter can use to log in to their dashboard if you don't use authentication tokens(auth_token) to sign promoters in automatically.

default_promotion_id
number

Promoter's default promotion id

pref
string

Promoter's parent referral id.

default_ref_id
string

Promoter's default referral id

note
string

A note/description of promoter

w8_form_url
string

The w8 form url

w9_form_url
string

The w9 form url

parent_promoter_id
string

Parent promoter id

earnings_balance
object

Promoter's earnings balance. This object can contain cash, credits, discount_per

current_balance
object

Promoter's current balance. This object can contain cash, credits, discount_per

paid_balance
object

Promoter's paid balance. This object can contain cash, credits, discount_per

auth_token
string

Authentication token generated when the promoter was created

profile
object
promotions
object[]