Skip to main content
GET
Get promoter details

Authorizations

Authorization
string
header
required

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 section → Manage API Keys

Headers

Account-ID
string
required

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

Path Parameters

id
string
required

The promoter's numeric ID, or the value of the attribute specified in find_by (e.g. an email address, auth token, ref token, promo code, or cust_id)

Query Parameters

find_by
enum<string>

Find by attribute

Available options:
email,
cust_id,
auth_token,
ref_token,
promo_code

Response

Successful response

id
integer

Id of the promoter

email
string

Email address of the promoter

name
string

Full name of the promoter

cust_id
string | null

Cust ID of the promoter

note
string | null

Optional note about the promoter

stats
object

Performance statistics for the promoter

is_customized
boolean

Whether the promoter has customized settings

fraud_suspicions
string[]

List of potential fraud flags

is_confirmed
boolean

Whether the promoter has confirmed their account

invoice_details_status
enum<string>

Status of the promoter's invoice details

Available options:
pending,
approved,
denied
profile
object
joined_at
string<date-time>

Date and time when the promoter joined.

last_login_at
string<date-time> | null

Date and time of the promoter's last login.

archived_at
string<date-time> | null

Date and time when the promoter was archived, if applicable.

custom_fields
object | null

Custom fields for the promoter, based on company settings. This is a key-value pair object where keys are custom field identifiers and values are the corresponding data.

password_setup_url
string | null

URL for the promoter to set up their password

first_event_at
string<date-time>

Date and time of the promoter's first activity.

promoter_campaigns
object[]

List of campaigns associated with the promoter

balances
object

Earnings balance breakdown for the promoter

track_ad_traffic
boolean | null

Whether ad traffic tracking is enabled for this promoter. Null means the campaign default is used.

auth_provider
string | null

OAuth provider used to authenticate (e.g. google). Null if using email/password.

selected_payout_method
object | null

The promoter's currently selected payout method. Omitted when the exclude_payout_method=true query parameter is set.

parent_promoter
object | null

The parent promoter (for sub-affiliate relationships). Only included when the include_parent_promoter=true query parameter is set.