Skip to main content
GET
/
v1
/
program
Get program details
curl --request GET \
  --url https://api.example.com/v1/program

​
Endpoint

GET https://api.partnero.com/v1/program
Returns comprehensive program information including details, statistics, program settings, and portal settings. The response structure varies based on the program type (affiliate or refer-a-friend).

​
Request

cURL
curl --location 'https://api.partnero.com/v1/program' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

​
Response

The response structure varies based on program type. Both types share the same top-level structure: program, stats, program_settings, and portal_settings.
200 OK
{
  "status": 1,
  "data": {
    "program": {
      "id": 1,
      "public_id": "MOBTGEKX",
      "website": "https://yourcompany.com",
      "initial": "A0",
      "type": "Affiliate",
      "name": "My Affiliate Program",
      "created_at": "2025-04-30",
      "last_edited": "2025-04-30"
    },
    "stats": {
      "total_partners": "12",
      "total_partners_growth": 0,
      "total_purchases": "45",
      "total_purchases_growth": 0,
      "total_signups": "30",
      "total_signups_growth": 0,
      "total_paid_accounts": "25",
      "total_paid_accounts_growth": 0,
      "total_reward": {
        "usd": "$337.47"
      },
      "total_reward_growth": 0,
      "total_revenue": {
        "usd": "$1,124.90"
      },
      "total_revenue_growth": 0,
      "affiliate_referred_visitors_clicks": "150",
      "affiliate_referred_visitors_clicks_growth": 0,
      "click_to_signup_conversion": "20",
      "click_to_signup_conversion_growth": 0,
      "signup_to_sale_conversion": "83",
      "signup_to_sale_conversion_growth": 0,
      "total_paid": [],
      "total_pending": [],
      "net_profit": 787.43,
      "net_profit_growth": 0,
      "net_profit_formatted": "$787.43",
      "average_order_value": {
        "usd": "$24.99"
      },
      "rewards_breakdown": {
        "unclaimed": {},
        "in_review": {},
        "paid": {}
      },
      "partner_activity": {
        "partners_with_signups": "8",
        "active_partners": "5",
        "approved": "10",
        "waiting_for_approval": "2",
        "rejected": "0"
      },
      "payout_status_breakdown": {
        "requested": { "count": 0, "amounts": {} },
        "approved": { "count": 0, "amounts": {} },
        "paid": { "count": 0, "amounts": {} },
        "rejected": { "count": 0, "amounts": {} },
        "resubmitted": { "count": 0, "amounts": {} },
        "total_requested_amounts": {},
        "total_waiting_amounts": {}
      }
    },
    "program_settings": {
      "currency": "USD",
      "cookie_lifetime": "7",
      "commission_description": "30%, lifetime",
      "commission_value": "30%",
      "has_multiple_commissions": false,
      "payout_threshold": 0,
      "payout_automation_enabled": false,
      "payout_automation_schedule": null,
      "welcome_email_enabled": false,
      "onboarding_enabled": false,
      "partner_email_notifications_enabled": false
    },
    "portal_settings": {
      "partner_portal_url": "https://myprogram.partneroapp.site",
      "program_page_enabled": true,
      "leads_page_enabled": false,
      "registration_disabled": false,
      "google_login_enabled": false,
      "passwordless_login_enabled": false,
      "sub_accounts_enabled": false,
      "widget_enabled": false,
      "signup_popup_enabled": false,
      "embeddable_form_enabled": false
    }
  }
}

​
Response fields

FieldTypeDescription
idintegerInternal program ID
public_idstringPublic program identifier
websitestringProgram landing page URL
typestringAffiliate, Referral, or Newsletter
namestringProgram name
created_atstringCreation date
last_editedstringLast modification date
FieldTypeDescription
total_partnersstringTotal number of partners
total_purchasesstringTotal number of purchases
total_signupsstringTotal referred sign-ups
total_paid_accountsstringTotal paid accounts
total_rewardobjectTotal rewards by currency
total_revenueobjectTotal revenue by currency
affiliate_referred_visitors_clicksstringTotal referral link clicks
click_to_signup_conversionstringClick-to-signup conversion rate (%)
signup_to_sale_conversionstringSignup-to-sale conversion rate (%)
net_profitnumberRevenue minus rewards
net_profit_formattedstringFormatted net profit with currency
average_order_valueobjectAverage order value by currency
rewards_breakdownobjectRewards split by status: unclaimed, in_review, paid
partner_activityobjectPartner counts by status
payout_status_breakdownobjectPayout counts and amounts by status
FieldTypeDescription
currencystringCommission currency (e.g., USD)
cookie_lifetimestringReferral cookie duration in days
commission_descriptionstringHuman-readable commission description
commission_valuestringCommission value
has_multiple_commissionsbooleanWhether advanced commissions are configured
payout_thresholdnumberMinimum amount required for payout
payout_automation_enabledbooleanWhether automated payouts are active
payout_automation_schedulestringPayout schedule description (if enabled)
welcome_email_enabledbooleanSend welcome email to new partners
onboarding_enabledbooleanPartner onboarding flow enabled
partner_email_notifications_enabledbooleanEmail notifications for partners
FieldTypeDescription
partner_portal_urlstringPartner portal URL
program_page_enabledbooleanPublic program page is active
leads_page_enabledbooleanLead submission page is active
registration_disabledbooleanPortal registration is disabled
google_login_enabledbooleanGoogle login/signup is enabled
passwordless_login_enabledbooleanPasswordless (OTP) login is enabled
sub_accounts_enabledbooleanPartner sub-accounts are enabled
widget_enabledbooleanPortal widget is enabled
signup_popup_enabledbooleanSignup pop-up is enabled
embeddable_form_enabledbooleanEmbeddable signup form is enabled
The legacy endpoint GET /v1/program/overview is still available for backward compatibility but returns a flat response format. New integrations should use GET /v1/program.