Leads
List leads/customers
With this endpoint you can list all the leads and customers assigned to a promotion, promoter, campaign or entire account using the API.
Pagination details are held on response headers. Add
--include
option on curl
request to see the pagination details format and links to next pages.HTTP Request
GET https://firstpromoter.com/api/v1/leads/list
GET
Authorizations
Query Parameters
List all leads and customer assigned to this promotion id
List all leads and customer assigned to a promotion - find promotion by ref_id
List all leads and customers assigned to a promoter
List all leads and customers in a campaign
Response
200 - application/json
ISO date string at which the lead/customer cancelled
ISO date string at which the lead/customer signed up
ISO date string at which the lead converted to a customer.
The lead's or customer's email
The lead's ID inside FirstPromoter
The lead's or customer's status
Available options:
signup
, active
, subscribed
, denied
, cancelled
Your lead/customer's user ID inside your application.