curl -X GET "https://api.chariow.com/v1/affiliates/CREATOR123" \
-H "Authorization: Bearer sk_live_your_api_key"
const response = await fetch('https://api.chariow.com/v1/affiliates/CREATOR123', {
headers: {
'Authorization': 'Bearer sk_live_your_api_key'
}
});
const { data } = await response.json();
console.log(data);
$ch = curl_init('https://api.chariow.com/v1/affiliates/CREATOR123');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
import requests
response = requests.get(
'https://api.chariow.com/v1/affiliates/CREATOR123',
headers={'Authorization': 'Bearer sk_live_your_api_key'}
)
data = response.json()
{
"data": {
"id": "saff_xyz789abc",
"status": "active",
"source": {
"label": "Invitation",
"description": "Added via store invitation",
"value": "invitation"
},
"total_visits": 150,
"total_sales": 25,
"total_earnings": {
"value": 1250,
"formatted": "$1,250.00",
"short": "1K",
"currency": "USD"
},
"first_visit_at": "2025-01-16T09:00:00+00:00",
"last_visit_at": "2025-01-25T14:30:00+00:00",
"suspended_at": null,
"suspended_reason": null,
"account": {
"id": "aff_abc123def",
"pseudo": "creative_studio",
"country": {
"name": "United States",
"code": "US",
"alpha_3_code": "USA",
"dial_code": "+1",
"currency": "USD",
"flag": "https://cdn.axazara.com/flags/svg/US.svg"
},
"status": "active",
"user": {
"id": "usr_def456",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"nickname": null,
"email": "john@example.com",
"profile_photo_url": null
},
"created_at": "2025-01-15T10:30:00+00:00"
},
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-25T14:30:00+00:00"
}
}
{
"message": "Affiliate not found. Please verify the affiliate code and ensure it is associated with this store.",
"errors": []
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"errors": []
}
Affiliates
Get Affiliate
Retrieve details of a specific affiliate by their unique code
curl -X GET "https://api.chariow.com/v1/affiliates/CREATOR123" \
-H "Authorization: Bearer sk_live_your_api_key"
const response = await fetch('https://api.chariow.com/v1/affiliates/CREATOR123', {
headers: {
'Authorization': 'Bearer sk_live_your_api_key'
}
});
const { data } = await response.json();
console.log(data);
$ch = curl_init('https://api.chariow.com/v1/affiliates/CREATOR123');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
import requests
response = requests.get(
'https://api.chariow.com/v1/affiliates/CREATOR123',
headers={'Authorization': 'Bearer sk_live_your_api_key'}
)
data = response.json()
{
"data": {
"id": "saff_xyz789abc",
"status": "active",
"source": {
"label": "Invitation",
"description": "Added via store invitation",
"value": "invitation"
},
"total_visits": 150,
"total_sales": 25,
"total_earnings": {
"value": 1250,
"formatted": "$1,250.00",
"short": "1K",
"currency": "USD"
},
"first_visit_at": "2025-01-16T09:00:00+00:00",
"last_visit_at": "2025-01-25T14:30:00+00:00",
"suspended_at": null,
"suspended_reason": null,
"account": {
"id": "aff_abc123def",
"pseudo": "creative_studio",
"country": {
"name": "United States",
"code": "US",
"alpha_3_code": "USA",
"dial_code": "+1",
"currency": "USD",
"flag": "https://cdn.axazara.com/flags/svg/US.svg"
},
"status": "active",
"user": {
"id": "usr_def456",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"nickname": null,
"email": "john@example.com",
"profile_photo_url": null
},
"created_at": "2025-01-15T10:30:00+00:00"
},
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-25T14:30:00+00:00"
}
}
{
"message": "Affiliate not found. Please verify the affiliate code and ensure it is associated with this store.",
"errors": []
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"errors": []
}
Retrieves detailed information about a specific affiliate by their unique affiliate code. This endpoint returns comprehensive affiliate information including their account details, performance statistics, and earnings. The code is matched exactly.
Required scope:
affiliates.read. A key without it receives a 403 error. See Authentication.Path Parameters
string
required
The unique affiliate code (e.g.,
CREATOR123, PARTNER2025)Response
object
Show properties
Show properties
string
Unique store affiliate identifier (e.g.,
saff_abc123xyz)string
Affiliate status:
active or suspendedobject
integer
Total number of visits through affiliate links
integer
Total number of sales made through referrals
object
string | null
ISO 8601 timestamp of first referral visit
string | null
ISO 8601 timestamp of most recent referral visit
string | null
ISO 8601 timestamp when the affiliate was suspended (if applicable)
string | null
Reason for suspension (if applicable)
object
Affiliate account details
Show account object
Show account object
string
Affiliate account public ID (e.g.,
aff_abc123def)string | null
Affiliate’s display name
object
Affiliate’s country:
name, code, alpha_3_code, dial_code, currency and flagstring
Account status
object
User details:
id, name, first_name, last_name, nickname, email and profile_photo_urlstring
Account creation timestamp
string
ISO 8601 creation timestamp
string
ISO 8601 last update timestamp
curl -X GET "https://api.chariow.com/v1/affiliates/CREATOR123" \
-H "Authorization: Bearer sk_live_your_api_key"
const response = await fetch('https://api.chariow.com/v1/affiliates/CREATOR123', {
headers: {
'Authorization': 'Bearer sk_live_your_api_key'
}
});
const { data } = await response.json();
console.log(data);
$ch = curl_init('https://api.chariow.com/v1/affiliates/CREATOR123');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
import requests
response = requests.get(
'https://api.chariow.com/v1/affiliates/CREATOR123',
headers={'Authorization': 'Bearer sk_live_your_api_key'}
)
data = response.json()
{
"data": {
"id": "saff_xyz789abc",
"status": "active",
"source": {
"label": "Invitation",
"description": "Added via store invitation",
"value": "invitation"
},
"total_visits": 150,
"total_sales": 25,
"total_earnings": {
"value": 1250,
"formatted": "$1,250.00",
"short": "1K",
"currency": "USD"
},
"first_visit_at": "2025-01-16T09:00:00+00:00",
"last_visit_at": "2025-01-25T14:30:00+00:00",
"suspended_at": null,
"suspended_reason": null,
"account": {
"id": "aff_abc123def",
"pseudo": "creative_studio",
"country": {
"name": "United States",
"code": "US",
"alpha_3_code": "USA",
"dial_code": "+1",
"currency": "USD",
"flag": "https://cdn.axazara.com/flags/svg/US.svg"
},
"status": "active",
"user": {
"id": "usr_def456",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"nickname": null,
"email": "john@example.com",
"profile_photo_url": null
},
"created_at": "2025-01-15T10:30:00+00:00"
},
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-25T14:30:00+00:00"
}
}
{
"message": "Affiliate not found. Please verify the affiliate code and ensure it is associated with this store.",
"errors": []
}
{
"message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
"errors": []
}
Was this page helpful?