List promoters
Use this endpoint to list your promoters using the API. The response will return the promoters as JSON array.
--include
option on curl
request to see the pagination details format and links to next pages.GET https://firstpromoter.com/api/v1/promoters/list
Use this endpoint to list your promoters using the API. The response will return the promoters as JSON array.
Authorizations
Query Parameters
List all promoters accepted to a specific campaign.
Response
Authentication token generated when the promoter was created
ISO date string when the promoter signed up
Promoter's current balance. This object can contain cash
, credits
, discount_per
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 default promotion id
Promoter's default referral id
Promoter's earnings balance. This object can contain cash
, credits
, discount_per
Promoter's email
The promoter's ID inside FirstPromoter
A note/description of promoter
Promoter's paid balance. This object can contain cash
, credits
, discount_per
Parent promoter id
Promoter's parent referral id.
Promoter's status
approved
, pending
, denied
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.
The w8 form url
The w9 form url