Skip to main content

​
Welcome to the Affonso API

The Affonso API allows you to programmatically manage your affiliate program. You can create affiliates, track referrals, manage commissions, and process payouts.

Authentication

Learn how to authenticate your API requests

Rate Limits

Understand API rate limits and best practices

​
Base URL

All API requests should be made to: 
https://api.affonso.io/v1

​
Available Resources

ResourceDescription
AffiliatesManage your affiliate users
ReferralsTrack referrals and conversions
ClicksRecord click events
CommissionsManage commission transactions
PayoutsProcess affiliate payouts

​
Partnership Status

The partnershipStatus field indicates the relationship status between an affiliate and a program:
  • APPROVED - Affiliate is active and can promote the program
  • PENDING - Affiliate applied but hasn’t been approved yet
  • REJECTED - Affiliate application was rejected
  • null - No partnership exists (affiliate hasn’t completed onboarding)
Note: partnershipStatus can be null for affiliates who haven’t completed their onboarding process yet. The status is only set after the affiliate applies to and gets approved/rejected for a specific program.

​
Response Format

All responses are returned in JSON format with the following structure:
Success Response
{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 100,
    "totalPages": 2,
    "hasNextPage": true,
    "hasPrevPage": false
  }
}
Error Response
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid email format"
  }
}

​
Need Help?

Support

Contact our support team for API assistance