curl -X GET "https://api.affonso.io/v1/program" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"id": "cm7xutqbb0001yfkcrnpextmp",
"name": "Acme SaaS",
"slug": "acme-saas",
"tagline": "Manage projects effortlessly",
"category": "SaaS",
"description": "The best project management tool for teams",
"website_url": "https://acme.com",
"access_mode": "public",
"status": "active",
"affiliate_links_enabled": true,
"logo_url": "https://cdn.affonso.io/logos/acme.png",
"default_referral_parameter": "ref",
"created_at": "2024-01-10T08:00:00.000Z",
"updated_at": "2024-06-15T14:30:00.000Z",
"plan": {
"tier": "growth",
"postbacks": true,
"groups_limit": 5
}
}
}
Info
Get Program Info
Get your affiliate program configuration and plan features
GET
/
v1
/
program
curl -X GET "https://api.affonso.io/v1/program" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"id": "cm7xutqbb0001yfkcrnpextmp",
"name": "Acme SaaS",
"slug": "acme-saas",
"tagline": "Manage projects effortlessly",
"category": "SaaS",
"description": "The best project management tool for teams",
"website_url": "https://acme.com",
"access_mode": "public",
"status": "active",
"affiliate_links_enabled": true,
"logo_url": "https://cdn.affonso.io/logos/acme.png",
"default_referral_parameter": "ref",
"created_at": "2024-01-10T08:00:00.000Z",
"updated_at": "2024-06-15T14:30:00.000Z",
"plan": {
"tier": "growth",
"postbacks": true,
"groups_limit": 5
}
}
}
Retrieve your affiliate program settings including name, description, status, and your current plan features.
Response
Always
true for successful responsesThe program info object with plan features.
Show Data Object Properties
Show Data Object Properties
Unique identifier for the program
Program name
URL-friendly program slug
Short tagline for the program
Program category
Program description
The program’s website URL
Program access mode:
public, private, or inviteProgram status (e.g.
active, inactive)Whether affiliate links are enabled
URL to the program’s logo image
Default referral query parameter name
ISO 8601 timestamp of when the program was created
ISO 8601 timestamp of the last update
Your current plan features and limits.
curl -X GET "https://api.affonso.io/v1/program" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"id": "cm7xutqbb0001yfkcrnpextmp",
"name": "Acme SaaS",
"slug": "acme-saas",
"tagline": "Manage projects effortlessly",
"category": "SaaS",
"description": "The best project management tool for teams",
"website_url": "https://acme.com",
"access_mode": "public",
"status": "active",
"affiliate_links_enabled": true,
"logo_url": "https://cdn.affonso.io/logos/acme.png",
"default_referral_parameter": "ref",
"created_at": "2024-01-10T08:00:00.000Z",
"updated_at": "2024-06-15T14:30:00.000Z",
"plan": {
"tier": "growth",
"postbacks": true,
"groups_limit": 5
}
}
}
Was this page helpful?
⌘I
