List affiliates
curl --request GET \
--url https://{domain}/api/v2/network/affiliates \
--header 'X-API-Key: <api-key>'import requests
url = "https://{domain}/api/v2/network/affiliates"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://{domain}/api/v2/network/affiliates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/v2/network/affiliates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{domain}/api/v2/network/affiliates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{domain}/api/v2/network/affiliates")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v2/network/affiliates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"code": 200,
"name": "OK",
"message": "<string>",
"info": {
"affiliates": [
{
"id": 123,
"external_id": "<string>",
"email": "<string>",
"firstname": "<string>",
"lastname": "<string>",
"auth_key": "<string>",
"access_token": "<string>",
"expiration_time": "<string>",
"contacts": "<string>",
"custom_fields": "<string>",
"account_type": 123,
"account_balance": "<string>",
"company_name": "<string>",
"website_url": "<string>",
"phone": "<string>",
"image": "<string>",
"notes": "<string>",
"internal_notes": "<string>",
"payment_methods": "<string>",
"payment_details": "<string>",
"status": 123,
"api_status": 123,
"api_key": "<string>",
"country": 123,
"region": "<string>",
"city": "<string>",
"address": "<string>",
"postal_code": "<string>",
"tags": "<string>",
"traffic_types": "<string>",
"ip": "<string>",
"referred_by": 123,
"referral_commission": "<string>",
"number_format_id": 123,
"date_format_id": 123,
"timezone": "<string>",
"block_traffic": 123,
"payout_approved": "<string>",
"payout_pending": "<string>",
"conversions": 123,
"email_notifications": 123,
"email_mailroom": 123,
"invoice_type": 123,
"invoice_frequency": 123,
"invoice_days_of_the_month": "<string>",
"invoice_day_of_the_week": "<string>",
"generate_invoice_automatically": 123,
"payment_terms": 123,
"beneficiary_name": "<string>",
"beneficiary_address": "<string>",
"billing_email": "<string>",
"tax_id": "<string>",
"vat": 123,
"pending_balance": "<string>",
"approved_balance": "<string>",
"referral_balance": "<string>",
"balance_due": "<string>",
"invoice_number_counter": 123,
"antifraud_logic_score": 123,
"created": 123,
"updated": 123,
"visited": 123,
"activity": 123,
"twoFA_enabled": 123,
"registration": "<string>",
"traffic_types_selected": "<string>",
"tags_selected": [
{
"id": "<string>",
"title": "<string>"
}
],
"managers_assigned": "<string>",
"country_selected": "<string>",
"referral_sponsor_info": "<string>",
"referrals_info": [
{}
],
"postbacks_count": 123,
"sources_count": 123,
"domains_count": 123,
"balances": {
"currency": "<string>",
"approved_balance": "<string>",
"pending_balance": "<string>",
"pending_cpa": "<string>",
"pending_rev_share": "<string>",
"approved_cpa": "<string>",
"approved_rev_share": "<string>",
"referral_balance": "<string>",
"balance_due": "<string>"
},
"live_stats": {
"key": "<string>",
"current": {
"ranges": [
"<string>"
],
"series": [
123
],
"total": 123,
"total_change": 123
},
"previous": {
"ranges": [
"<string>"
],
"series": [
123
],
"total": 123,
"total_change": 123
}
},
"multi_accounts": {
"ip": [
{}
],
"payment_method": [
{}
],
"global_postback": [
{}
]
},
"tier": {
"id": 123,
"title": "<string>",
"color": "<string>",
"isDefault": true
},
"commission_plans": [
{}
],
"enable_master": 123
}
]
}
}{
"message": "Request could not be parsed.",
"success": false,
"info": {
"errors": {}
}
}{
"message": "API key is invalid or missing.",
"success": false
}{
"message": "This endpoint is not available for your role.",
"success": false
}{
"message": "Resource not found.",
"success": false
}{
"message": "An unexpected error occurred.",
"success": false,
"info": {
"errors": {}
}
}Affiliates
List affiliates
Returns paginated list of affiliates with optional filtering and sorting.
GET
/
api
/
v2
/
network
/
affiliates
List affiliates
curl --request GET \
--url https://{domain}/api/v2/network/affiliates \
--header 'X-API-Key: <api-key>'import requests
url = "https://{domain}/api/v2/network/affiliates"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://{domain}/api/v2/network/affiliates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/v2/network/affiliates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{domain}/api/v2/network/affiliates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{domain}/api/v2/network/affiliates")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v2/network/affiliates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"code": 200,
"name": "OK",
"message": "<string>",
"info": {
"affiliates": [
{
"id": 123,
"external_id": "<string>",
"email": "<string>",
"firstname": "<string>",
"lastname": "<string>",
"auth_key": "<string>",
"access_token": "<string>",
"expiration_time": "<string>",
"contacts": "<string>",
"custom_fields": "<string>",
"account_type": 123,
"account_balance": "<string>",
"company_name": "<string>",
"website_url": "<string>",
"phone": "<string>",
"image": "<string>",
"notes": "<string>",
"internal_notes": "<string>",
"payment_methods": "<string>",
"payment_details": "<string>",
"status": 123,
"api_status": 123,
"api_key": "<string>",
"country": 123,
"region": "<string>",
"city": "<string>",
"address": "<string>",
"postal_code": "<string>",
"tags": "<string>",
"traffic_types": "<string>",
"ip": "<string>",
"referred_by": 123,
"referral_commission": "<string>",
"number_format_id": 123,
"date_format_id": 123,
"timezone": "<string>",
"block_traffic": 123,
"payout_approved": "<string>",
"payout_pending": "<string>",
"conversions": 123,
"email_notifications": 123,
"email_mailroom": 123,
"invoice_type": 123,
"invoice_frequency": 123,
"invoice_days_of_the_month": "<string>",
"invoice_day_of_the_week": "<string>",
"generate_invoice_automatically": 123,
"payment_terms": 123,
"beneficiary_name": "<string>",
"beneficiary_address": "<string>",
"billing_email": "<string>",
"tax_id": "<string>",
"vat": 123,
"pending_balance": "<string>",
"approved_balance": "<string>",
"referral_balance": "<string>",
"balance_due": "<string>",
"invoice_number_counter": 123,
"antifraud_logic_score": 123,
"created": 123,
"updated": 123,
"visited": 123,
"activity": 123,
"twoFA_enabled": 123,
"registration": "<string>",
"traffic_types_selected": "<string>",
"tags_selected": [
{
"id": "<string>",
"title": "<string>"
}
],
"managers_assigned": "<string>",
"country_selected": "<string>",
"referral_sponsor_info": "<string>",
"referrals_info": [
{}
],
"postbacks_count": 123,
"sources_count": 123,
"domains_count": 123,
"balances": {
"currency": "<string>",
"approved_balance": "<string>",
"pending_balance": "<string>",
"pending_cpa": "<string>",
"pending_rev_share": "<string>",
"approved_cpa": "<string>",
"approved_rev_share": "<string>",
"referral_balance": "<string>",
"balance_due": "<string>"
},
"live_stats": {
"key": "<string>",
"current": {
"ranges": [
"<string>"
],
"series": [
123
],
"total": 123,
"total_change": 123
},
"previous": {
"ranges": [
"<string>"
],
"series": [
123
],
"total": 123,
"total_change": 123
}
},
"multi_accounts": {
"ip": [
{}
],
"payment_method": [
{}
],
"global_postback": [
{}
]
},
"tier": {
"id": 123,
"title": "<string>",
"color": "<string>",
"isDefault": true
},
"commission_plans": [
{}
],
"enable_master": 123
}
]
}
}{
"message": "Request could not be parsed.",
"success": false,
"info": {
"errors": {}
}
}{
"message": "API key is invalid or missing.",
"success": false
}{
"message": "This endpoint is not available for your role.",
"success": false
}{
"message": "Resource not found.",
"success": false
}{
"message": "An unexpected error occurred.",
"success": false,
"info": {
"errors": {}
}
}Authorizations
ApiKeyHeaderAuthApiKeyAuth
Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.
Query Parameters
Page number.
Items per page.
Sort field.
Sort direction.
Available options:
asc, desc Search by text or ID.
Comma-separated column keys.
Was this page helpful?
⌘I