curl -X GET "https://api.affonso.io/v1/program/portal" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"single_program_portal": false,
"hide_branding": true,
"hide_details": false,
"primary_color": "#881337",
"secondary_color": "#f0f0f0",
"show_leaderboard": true,
"terms_conditions_status": true,
"terms_conditions_value": "https://acme.com/terms",
"privacy_policy_status": true,
"privacy_policy_value": "https://acme.com/privacy",
"support_email_status": true,
"support_email_value": "affiliates@acme.com",
"custom_texts": null
}
}
Portal
Get Portal Settings
Get the affiliate portal appearance and configuration settings
GET
/
v1
/
program
/
portal
curl -X GET "https://api.affonso.io/v1/program/portal" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"single_program_portal": false,
"hide_branding": true,
"hide_details": false,
"primary_color": "#881337",
"secondary_color": "#f0f0f0",
"show_leaderboard": true,
"terms_conditions_status": true,
"terms_conditions_value": "https://acme.com/terms",
"privacy_policy_status": true,
"privacy_policy_value": "https://acme.com/privacy",
"support_email_status": true,
"support_email_value": "affiliates@acme.com",
"custom_texts": null
}
}
Retrieve the affiliate portal settings including branding, colors, legal pages, and leaderboard configuration.
Response
boolean
Always
true for successful responsesobject | null
The portal settings object, or
null if not yet configured.Show Data Object Properties
Show Data Object Properties
boolean
Show only one program in the portal
boolean
Hide Affonso branding from the portal
boolean
Hide program details from affiliates
string | null
Primary brand color (hex code)
string | null
Secondary brand color (hex code)
boolean
Show the affiliate leaderboard
boolean
Whether terms & conditions are enabled
string | null
Terms & conditions content or URL
boolean
Whether privacy policy is enabled
string | null
Privacy policy content or URL
boolean
Whether support email is displayed
string | null
Support email address
object | null
Custom text overrides for portal UI elements
curl -X GET "https://api.affonso.io/v1/program/portal" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"single_program_portal": false,
"hide_branding": true,
"hide_details": false,
"primary_color": "#881337",
"secondary_color": "#f0f0f0",
"show_leaderboard": true,
"terms_conditions_status": true,
"terms_conditions_value": "https://acme.com/terms",
"privacy_policy_status": true,
"privacy_policy_value": "https://acme.com/privacy",
"support_email_status": true,
"support_email_value": "affiliates@acme.com",
"custom_texts": null
}
}
Was this page helpful?
⌘I