Sign in

v1

latestOpenAPI 3.0.02026-07-264731126.7 KB
Promoters

Get available promoters

With this endpoint you can list all promoters. <Tip>HTTP Request <br/>GET https://api.firstpromoter.com/api/v2/company/promoters</Tip>

get/promoters

Query parameters

qstring

Search params for promoters, search using, email, name or ref_id

ids[]integer[]

Array of promoter ids to get

state'pending' | 'accepted' | 'rejected' | 'blocked' | 'inactive' | 'not_set'

Promoter state filter

has_wform'yes' | 'no'

Has wform filter

parent_promoter_idinteger

Parent promoter id

archived'true' | 'false' | '`true`' | '`false`' | '`yes`' | '`no`'

Archived filter

subscribed_to_email'true' | 'false' | '`true`' | '`false`' | '`yes`' | '`no`'

Subscribed to email filter

fraud_suspicionsstring[]
invoice_details_status'approved' | 'pending' | 'rejected' | 'not_submitted'

Filter promoters by their invoice details status

Filter params

clicks_count'asc' | 'desc'
referrals_count'asc' | 'desc'
customers_count'asc' | 'desc'
revenue_amount'asc' | 'desc'
joined_at'asc' | 'desc'

Sorting params

Headers

Account-IDstring required

Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Response

Successful response

Example response

{
  "data": [
    {
      "profile": {
        "country": "US"
      }
    }
  ]
}