Show promoter details and balance
You can identify promoters by: id
, cust_id
, auth_token
, promoter_email
or ref_id
(referral id). You need to pass at least one of these parameters.
GET https://firstpromoter.com/api/v1/promoters/show
Authorizations
Query Parameters
required if promoter_email, ref_id, auth_token or cust_id is null
`The promoter's ID inside FirstPromoter
required if id, ref_id, auth_token or cust_id is null
The promoter's email
required if id, ref_id, auth_token or promoter_email is null
Your customer's user ID inside your application/system for the promoter.
required if the promoter_email,auth_token, id or cust_id is null
Referral ID.
required if the promoter_email, id, ref_id or cust_id is null
Authentication token generated when the promoter was created
Response
The promoter's ID inside FirstPromoter
Promoter's status
approved
, pending
, denied
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.
Promoter's email
ISO date string when the promoter signed up
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.
Promoter's default promotion id
Promoter's parent referral id.
Promoter's default referral id
A note/description of promoter
The w8 form url
The w9 form url
Parent promoter id
Promoter's earnings balance. This object can contain cash
, credits
, discount_per
Promoter's current balance. This object can contain cash
, credits
, discount_per
Promoter's paid balance. This object can contain cash
, credits
, discount_per
Authentication token generated when the promoter was created