curl -X GET "https://api.affonso.io/v1/program/groups" \
-H "Authorization: Bearer sk_live_your_api_key"
curl -X GET "https://api.affonso.io/v1/program/groups?expand=incentives,multi_level_incentives" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": [
{
"id": "efbf3f29-efb1-4837-8924-7322606858f3",
"name": "Default",
"description": "Default affiliate group",
"custom_website_url": null,
"is_default": true,
"created_at": "2024-01-10T08:00:00.000Z"
},
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Premium Partners",
"description": "High-performing affiliates with higher commissions",
"custom_website_url": "https://partners.acme.com",
"is_default": false,
"created_at": "2024-03-01T12:00:00.000Z"
}
]
}
Affiliate Groups
List Groups
List all affiliate groups for your program
GET
/
v1
/
program
/
groups
curl -X GET "https://api.affonso.io/v1/program/groups" \
-H "Authorization: Bearer sk_live_your_api_key"
curl -X GET "https://api.affonso.io/v1/program/groups?expand=incentives,multi_level_incentives" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": [
{
"id": "efbf3f29-efb1-4837-8924-7322606858f3",
"name": "Default",
"description": "Default affiliate group",
"custom_website_url": null,
"is_default": true,
"created_at": "2024-01-10T08:00:00.000Z"
},
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Premium Partners",
"description": "High-performing affiliates with higher commissions",
"custom_website_url": "https://partners.acme.com",
"is_default": false,
"created_at": "2024-03-01T12:00:00.000Z"
}
]
}
List all affiliate groups for your program. Use the
expand parameter to include nested incentive and multi-level incentive data.
Query Parameters
string
Comma-separated list of fields to expand. Valid values:
incentives, multi_level_incentives.Response
boolean
Always
true for successful responsesarray
Array of group objects.
Show Group Object Properties
Show Group Object Properties
string
Unique identifier for the group
string
Group name
string | null
Group description
string | null
Custom website URL for this group
boolean
Whether this is the default group for new affiliates
string
ISO 8601 timestamp
array
Included when
expand=incentives. Array of incentive objects.Show Incentive Properties
Show Incentive Properties
string
Group-incentive link ID
string
Incentive ID
string
Incentive name
string
Type (e.g.
commission)number
Commission amount
boolean
Whether amount is a percentage
string
Duration (e.g.
customer_lifetime, time_limited)integer | null
Duration value (for time-limited)
string
Approval type (e.g.
automatic, hold_period)integer | null
Hold period in days
boolean
Whether variable commission is enabled
object | null
Variable commission configuration
string
What the incentive applies to
array
Product IDs this incentive applies to
curl -X GET "https://api.affonso.io/v1/program/groups" \
-H "Authorization: Bearer sk_live_your_api_key"
curl -X GET "https://api.affonso.io/v1/program/groups?expand=incentives,multi_level_incentives" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": [
{
"id": "efbf3f29-efb1-4837-8924-7322606858f3",
"name": "Default",
"description": "Default affiliate group",
"custom_website_url": null,
"is_default": true,
"created_at": "2024-01-10T08:00:00.000Z"
},
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Premium Partners",
"description": "High-performing affiliates with higher commissions",
"custom_website_url": "https://partners.acme.com",
"is_default": false,
"created_at": "2024-03-01T12:00:00.000Z"
}
]
}
Was this page helpful?
⌘I