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",
"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",
"customer_information_visibility": "hidden",
"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",
"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",
"customer_information_visibility": "hidden",
"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
boolean
Always
true for successful responsesobject
The program info object with plan features.
Show Data Object Properties
Show Data Object Properties
string
Unique identifier for the program
string
Program name
string | null
URL-friendly program slug
string | null
Short tagline for the program
string | null
Program description
string
Deprecated compatibility alias for the global promotion URL. Use Promotion URLs for new integrations.
string
Program access mode:
public, private, or invitestring
Program status (e.g.
active, inactive)boolean
Whether affiliate links are enabled
string | null
URL to the program’s logo image
string
Customer information that affiliates can see:
hidden, name, email, or name_and_email.string
Default referral query parameter name
string
ISO 8601 timestamp of when the program was created
string
ISO 8601 timestamp of the last update
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",
"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",
"customer_information_visibility": "hidden",
"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