Skip to main content
GET
Get Affiliate by ID
Retrieve a single affiliate by its ID. Use the relationship query parameter to include related data such as users, signup, billing, coupon_codes, visibility, reporting, and more.

Authorizations

X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Path Parameters

affiliateId
integer
required

The unique affiliate ID.

Query Parameters

relationship
enum<string>

Include related data. Repeat for multiple relationships.

Available options:
reporting,
billing,
coupon_codes,
users,
audits,
visibility,
signup,
api,
traffic_source,
referral_link,
referrer,
referral,
supply_partner

Response

network_affiliate_id
integer

Unique affiliate ID.

network_id
integer

Network ID.

name
string

Affiliate name.

account_status
enum<string>

Current account status.

Available options:
active,
inactive,
pending,
suspended
network_employee_id
integer

Account manager employee ID.

internal_notes
string

Internal notes about this affiliate (not visible to the affiliate).

default_currency_id
string

ISO currency code for the affiliate's default currency.

Whether media cost tracking is enabled on this affiliate's links.

is_contact_address_enabled
boolean

Whether a contact address is stored for this affiliate.

has_notifications
boolean

Whether notifications are enabled.

network_traffic_source_id
integer

Associated traffic source ID.

account_executive_id
integer

Account executive employee ID.

adress_id
integer

Address record ID. Note the field name uses a single 'd' (adress_id) in the API response.

referrer_id
integer

ID of the referring affiliate, if any.

time_created
integer

Unix timestamp of creation.

Example:

1734455015

time_saved
integer

Unix timestamp of last update.

Example:

1734455015

relationship
object

Related data (only present when requested via the relationship query parameter).