Affiliates
Read only.
GET /affiliates
Affiliate click count
Scope: balance:read, or the broad read.
Parameters
| Name | Where | Description |
|---|---|---|
If-None-Match | header | An ETag from an earlier response. |
Example request
curl "https://www.seoclerk.com/api/v1/affiliates" \
-H "Authorization: Bearer $SEOCLERKS_API_KEY"
Response 200
| Field | Type | Description |
|---|---|---|
clicks | integer |
{
"data": {
"clicks": 1
},
"meta": {
"request_id": "9f2c4e1ab07d3351"
}
}
Errors
| Status | Codes |
|---|---|
| 400 | https_required key_in_query |
| 401 | account_unavailable invalid_credentials key_expired key_revoked |
| 403 | missing_scope |
| 404 | not_found |
| 405 | method_not_allowed |
| 422 | invalid_parameter |
| 429 | rate_limited |
| 500 | internal_error |
GET /affiliates/clicks
Alias of affiliates
Scope: balance:read, or the broad read.
Parameters
| Name | Where | Description |
|---|---|---|
If-None-Match | header | An ETag from an earlier response. |
Example request
curl "https://www.seoclerk.com/api/v1/affiliates/clicks" \
-H "Authorization: Bearer $SEOCLERKS_API_KEY"
Response 200
| Field | Type | Description |
|---|---|---|
clicks | integer |
{
"data": {
"clicks": 1
},
"meta": {
"request_id": "9f2c4e1ab07d3351"
}
}
Errors
| Status | Codes |
|---|---|
| 400 | https_required key_in_query |
| 401 | account_unavailable invalid_credentials key_expired key_revoked |
| 403 | missing_scope |
| 404 | not_found |
| 405 | method_not_allowed |
| 422 | invalid_parameter |
| 429 | rate_limited |
| 500 | internal_error |
GET /affiliates/earnings
Affiliate earnings posted to the balance
Scope: balance:read, or the broad read. Newest first, by id.
Parameters
| Name | Where | Description |
|---|---|---|
cursor | query | meta.next_cursor from the previous page. Up to 1024 characters. |
limit | query | Page size. Above 100 is treated as 100. At least 1. Default 25. |
If-None-Match | header | An ETag from an earlier response. |
Example request
curl "https://www.seoclerk.com/api/v1/affiliates/earnings" \
-H "Authorization: Bearer $SEOCLERKS_API_KEY"
Response 200
A page of these in data, with meta.limit and meta.next_cursor.
| Field | Type | Description |
|---|---|---|
id | integer | |
amount | money | |
payment_id | integer | |
created_at | timestamp or null | |
site | string |
{
"data": [
{
"id": 1024,
"amount": {
"amount": "12.50",
"currency": "USD"
},
"payment_id": 1024,
"created_at": "2026-10-10T14:03:22Z",
"site": "SEOClerks"
}
],
"meta": {
"limit": 1,
"next_cursor": "string",
"request_id": "9f2c4e1ab07d3351"
}
}
Errors
| Status | Codes |
|---|---|
| 400 | https_required key_in_query |
| 401 | account_unavailable invalid_credentials key_expired key_revoked |
| 403 | missing_scope |
| 404 | not_found |
| 405 | method_not_allowed |
| 422 | bad_cursor invalid_id invalid_parameter |
| 429 | rate_limited |
| 500 | internal_error |
GET /affiliates/members
Members you referred
Scope: balance:read, or the broad read. Newest first, by id.
Parameters
| Name | Where | Description |
|---|---|---|
cursor | query | meta.next_cursor from the previous page. Up to 1024 characters. |
limit | query | Page size. Above 100 is treated as 100. At least 1. Default 25. |
If-None-Match | header | An ETag from an earlier response. |
Example request
curl "https://www.seoclerk.com/api/v1/affiliates/members" \
-H "Authorization: Bearer $SEOCLERKS_API_KEY"
Response 200
A page of these in data, with meta.limit and meta.next_cursor.
| Field | Type | Description |
|---|---|---|
id | integer | |
username | string | |
joined_at | timestamp or null |
{
"data": [
{
"id": 1024,
"username": "example",
"joined_at": "2026-10-10T14:03:22Z"
}
],
"meta": {
"limit": 1,
"next_cursor": "string",
"request_id": "9f2c4e1ab07d3351"
}
}
Errors
| Status | Codes |
|---|---|
| 400 | https_required key_in_query |
| 401 | account_unavailable invalid_credentials key_expired key_revoked |
| 403 | missing_scope |
| 404 | not_found |
| 405 | method_not_allowed |
| 422 | bad_cursor invalid_id invalid_parameter |
| 429 | rate_limited |
| 500 | internal_error |
GET /affiliates/payments
Payments by members you referred
Scope: balance:read, or the broad read. Newest first, by id.
Parameters
| Name | Where | Description |
|---|---|---|
cursor | query | meta.next_cursor from the previous page. Up to 1024 characters. |
limit | query | Page size. Above 100 is treated as 100. At least 1. Default 25. |
If-None-Match | header | An ETag from an earlier response. |
Example request
curl "https://www.seoclerk.com/api/v1/affiliates/payments" \
-H "Authorization: Bearer $SEOCLERKS_API_KEY"
Response 200
A page of these in data, with meta.limit and meta.next_cursor.
| Field | Type | Description |
|---|---|---|
id | integer | |
order_id | integer | |
payment_amount | money | |
status | integer | The order's status. |
cancelled | boolean | |
credited_to_balance | money or null | |
direct_payment | boolean | Paid to the seller's own gateway. |
processed | boolean | |
created_at | timestamp or null | |
cleared_at | timestamp or null | |
site | string | |
buyer_id | integer | On balance/sales. |
fee_paid | boolean | On affiliates/payments. |
{
"data": [
{
"id": 1024,
"order_id": 1024,
"payment_amount": {
"amount": "12.50",
"currency": "USD"
},
"status": 1,
"cancelled": true,
"credited_to_balance": {
"amount": "12.50",
"currency": "USD"
},
"direct_payment": true,
"processed": true,
"created_at": "2026-10-10T14:03:22Z",
"cleared_at": "2026-10-10T14:03:22Z",
"site": "SEOClerks",
"buyer_id": 1024,
"fee_paid": true
}
],
"meta": {
"limit": 1,
"next_cursor": "string",
"request_id": "9f2c4e1ab07d3351"
}
}
Errors
| Status | Codes |
|---|---|
| 400 | https_required key_in_query |
| 401 | account_unavailable invalid_credentials key_expired key_revoked |
| 403 | missing_scope |
| 404 | not_found |
| 405 | method_not_allowed |
| 422 | bad_cursor invalid_id invalid_parameter |
| 429 | rate_limited |
| 500 | internal_error |