Recomly APIEndpoints
List referrals
Retrieve all referrals for a campaign, optionally filtered by status.
GET /api/app/campaigns/{campaignId}/referrals
Returns all referrals for a campaign. Each referral includes the advocate's name for display purposes. Results can be filtered by status using the optional query parameter.
Request
See API Basics for required headers.
Query parameters
| Parameter | Type | Description |
|---|---|---|
status | "pending" | "converted" | Filter referrals by status. Omit to return all statuses. |
Sample request
curl "https://api.recomly.com/api/app/campaigns/c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012/referrals?status=pending" \
-H "Authorization: Bearer rk_live_abc123:def456"Sample response
Status: 200 OK
{
"referrals": [
{
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"referralId": "g1e7c5d3-94f6-4h0g-ceg7-5i7j9k1l2345",
"campaignId": "c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012",
"campaignName": "Spring Referral Drive",
"advocateId": "e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123",
"advocateName": "Jane Smith",
"status": "pending",
"friendName": "Alice Wang",
"friendEmail": "alice@example.com",
"createdAt": "2026-04-07T09:15:00.000Z"
}
]
}Error responses
See API Basics for standard status codes and error response format.