Referrals
Get available referrals
Get available referrals
HTTP Request
GET https://v2.firstpromoter.com/api/v2/company/referrals
GET
Authorizations
API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations → Manage API Keys
Headers
Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations
Query Parameters
Search params. Searches by email, uid, username, website
Array of referral ids to get
Filter the referrals by type (lead or customer)
Available options:
lead
, customer
Filter the referrals by a promoter id
Filter the referrals by state
Available options:
subscribed
, signup
, active
, cancelled
, refunded
, denied
, pending
, moved
Response
200
application/json
List of referrals
The response is of type object[]
.