Skip to main content
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",
    "auto_approve": true,
    "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

success
boolean
Always true for successful responses
data
object
The program info object with plan features.
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",
    "auto_approve": true,
    "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
    }
  }
}