curl -X GET "https://api.affonso.io/v1/program/campaigns/cmretainer01camp0001/retainer-periods?page=1&limit=50" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": [
{
"id": "cmperiod01retainer001",
"campaign_id": "cmretainer01camp0001",
"application_id": "cmapp01retainer0001",
"affiliate_id": "aff_abc123",
"period_start": "2026-11-01T00:00:00.000Z",
"amount": 500,
"earning_id": "cmearn01retainer001",
"earning_status": "PENDING_MANUAL_APPROVAL",
"condition": "Post at least 3 Shorts per week mentioning our product",
"created_at": "2026-11-01T00:05:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 50,
"total": 1,
"total_pages": 1,
"has_next_page": false,
"has_prev_page": false
}
}
Campaigns
List Retainer Periods
List open retainer periods waiting for manual approval
GET
/
v1
/
program
/
campaigns
/
{id}
/
retainer-periods
curl -X GET "https://api.affonso.io/v1/program/campaigns/cmretainer01camp0001/retainer-periods?page=1&limit=50" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": [
{
"id": "cmperiod01retainer001",
"campaign_id": "cmretainer01camp0001",
"application_id": "cmapp01retainer0001",
"affiliate_id": "aff_abc123",
"period_start": "2026-11-01T00:00:00.000Z",
"amount": 500,
"earning_id": "cmearn01retainer001",
"earning_status": "PENDING_MANUAL_APPROVAL",
"condition": "Post at least 3 Shorts per week mentioning our product",
"created_at": "2026-11-01T00:05:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 50,
"total": 1,
"total_pages": 1,
"has_next_page": false,
"has_prev_page": false
}
}
List retainer periods whose earning is
PENDING_MANUAL_APPROVAL. Requires read:affiliates. Foreign-team campaign IDs return 404.
Path Parameters
string
required
Encoded campaign id
Query Parameters
integer
default:"1"
Page number for pagination. Must be a positive integer.
integer
default:"50"
Number of results per page. Maximum value is 200. Default is 50.
Response
Paginated list of open retainer periods.boolean
Always
true for successful responsesarray
Array of retainer period objects.
Show Period Object Properties
Show Period Object Properties
string
Encoded period id
string
Encoded campaign id
string
Encoded application id
string
Affiliate id
string
ISO 8601 start of the retainer period
number | null
Period earning amount
string | null
Encoded affiliate earning id
string | null
Earning status. Listed periods are
PENDING_MANUAL_APPROVAL.string | null
Retainer condition text copied from the application, or
nullstring
ISO 8601 creation timestamp
object
Pagination metadata:
page, limit, total, total_pages, has_next_page, has_prev_page.curl -X GET "https://api.affonso.io/v1/program/campaigns/cmretainer01camp0001/retainer-periods?page=1&limit=50" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": [
{
"id": "cmperiod01retainer001",
"campaign_id": "cmretainer01camp0001",
"application_id": "cmapp01retainer0001",
"affiliate_id": "aff_abc123",
"period_start": "2026-11-01T00:00:00.000Z",
"amount": 500,
"earning_id": "cmearn01retainer001",
"earning_status": "PENDING_MANUAL_APPROVAL",
"condition": "Post at least 3 Shorts per week mentioning our product",
"created_at": "2026-11-01T00:05:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 50,
"total": 1,
"total_pages": 1,
"has_next_page": false,
"has_prev_page": false
}
}
Notes
- Requires
read:affiliates. - Only periods with earnings in
PENDING_MANUAL_APPROVALare returned. - Approve with Approve Retainer Period or reject with Reject Retainer Period.
Was this page helpful?