Skip to content

Affiliates export

Exports your affiliate accounts as a GZIP-compressed CSV file, one row per affiliate, including profile data, payout and referral settings, and current balances.

Request example

curl -X POST https://affiliatecontrol-api.com/external/exports/affiliates \
  -H "x-access-key: ak_example123" \
  -H "x-secret-key: sk_example456" \
  -H "Content-Type: application/json" \
  -d '{
    "currency_code": "USD",
    "webhook_url": "https://example.com/hook"
  }'

Parameters:

  • currency_code (String): Currency for last_month_revenue. Defaults to your account's default currency.
  • webhook_url (String): URL notified when the file is ready.

Response:

{ "id": "export-id-here" }

Output fields

# Field Type Description
1 id string Affiliate ID (UUID).
2 incrementing_id number SID — sequential numeric affiliate ID.
3 email string Email.
4 email_verified boolean Whether the email is verified.
5 first_name string | null First Name.
6 last_name string | null Last Name.
7 country_code string | null Country Code (ISO 3166-1 alpha-2).
8 language_code string ISO 639-1 language code.
9 date_of_birth string (date) | null Date of birth.
10 phone_number string | null Phone number.
11 account_status enum pending | approved | blocked | rejected.
12 messenger enum | null Messenger platform (e.g. telegram, whatsapp, …).
13 messenger_id string | null Messenger handle / ID.
14 payments_enabled boolean Whether payouts are enabled.
15 site_payment_method_id string | null Selected payout method.
16 payment_wallet string | null Payout wallet / account.
17 payments_net enum Payout cycle (net7 / net15 / net30 / net60 / manual).
18 payments_negative_carryover boolean Whether a negative balance carries over.
19 referred_by_id string | null Referring affiliate ID.
20 referred_by_email string | null Referring affiliate email.
21 referral_program_enabled boolean Whether the referral program is active.
22 referral_percent number Referral commission percent.
23 referral_payment_type enum Referral basis (ggr / ngr / net_project_profit).
24 media_buying_enabled boolean Whether media buying is enabled.
25 team_id string | null Team ID the affiliate belongs to.
26 team_name string | null Team name the affiliate belongs to.
27 last_month_revenue_currency_code string Currency of last_month_revenue (= requested currency_code).
28 last_month_revenue number Last Month Revenue.
29 wallet_currency_code string Currency of the balance fields below.
30 hold_balance number Hold — held / pending balance.
31 available_balance number Balance — withdrawable balance.
32 created_at string (datetime) Registered (account creation timestamp).