Details and referred organizations for your referral code
get
https://api.expiryedge.com/v1/getReferralCodeDetailsbearer token and the code's owner (referee) or a superadmin for the full view; no token for the public view60/min
Request
curl 'https://api.expiryedge.com/v1/getReferralCodeDetails?code=CONTOSO25' \
-H "Authorization: Bearer $EXPIRYEDGE_API_KEY"Response
{
"code_info": {
"referral_code": "CONTOSO25",
"referee_name": "Contoso Legal",
"referee_email": "partners@contosolegal.com",
"active": true,
"current_uses": 3,
"user_discount_percentage": 25,
"user_discount_period": "monthly",
"user_discount_duration": 3,
"referrer_commission_percentage": 20,
"created_at": "2026-06-01T10:00:00.000Z"
},
"organizations": [
{
"organization_id": "org_northwind",
"organization_name": "Northwind Dental",
"created_at": "2026-09-27T14:05:00.000Z",
"referred_at": "2026-09-27T14:05:00.000Z",
"subscription_plan": "trial",
"subscription_status": "active"
}
],
"total_organizations": 1
}Without an Authorization header the response is only the public offer terms (ReferralCodePublic, strict rate tier
10 / 15 min per IP) - used by the signup page's referral banner. With a token, codes you do not own return 404, same
as unknown codes; lists every referred organization; unbounded.
codestringrequired
200
Code details (full view with a token, public offer terms without one).
(body)one ofOne ofcode_infoobjectrequiredA referral code document (commercial terms are set by ExpiryEdge).organizationsarray of objectsrequiredtotal_organizationsintegerrequired
400 | The request is missing required fields or contains invalid values. |
401 | Missing, expired or invalid bearer token. |
404 | The record does not exist or is not in your organization. |
429 | Too many requests for this endpoint from your IP. Wait Retry-After seconds. |
500 | Unexpected server error. Retry later; quote requestId to support. |
