Skip to main content
GET
/
referrals
/
{id}
Get referral
curl --request GET \
  --url https://api.affonso.io/v1/referrals/{id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "id": "<string>",
    "affiliate_id": "<string>",
    "program_id": "<string>",
    "email": "<string>",
    "customer_id": "<string>",
    "subscription_id": "<string>",
    "status": "lead",
    "name": "<string>",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "converted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Prefix with 'sk_live_' for production or 'sk_dev_' for development.

Path Parameters

id
string
required

Referral ID

Query Parameters

expand
string

Expand affiliate data

Example:

"affiliate"

include
string

Include additional data

Example:

"stats"

Response

Referral details

success
boolean
data
object