Recomly APIEndpoints
Get advocate
Retrieve a single advocate and all of their referrals.
GET /api/app/campaigns/{campaignId}/advocates/{advocateId}
Returns a single advocate and the full list of referrals they have sent on this campaign.
Request
See API Basics for required headers.
This endpoint takes no request body or query parameters.
Sample request
curl https://api.recomly.com/api/app/campaigns/c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012/advocates/e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123 \
-H "Authorization: Bearer rk_live_abc123:def456"Sample response
Status: 200 OK
{
"advocate": {
"advocateId": "e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123",
"campaignId": "c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012",
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"name": "Jane Smith",
"email": "jane@example.com",
"notificationPreference": "email",
"referralCode": "a1b2c3d4",
"portalToken": "7f3a1d2e4b5c6f8a9e0d1b2c3f4a5e6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f",
"creditBalanceCents": 2500,
"enrolledAt": "2026-04-04T15:00:00.000Z"
},
"referrals": [
{
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"referralId": "f0d6b4c2-83e5-4g9f-bdf6-4h6i8j0k1234",
"campaignId": "c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012",
"campaignName": "Spring Referral Drive",
"advocateId": "e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123",
"status": "converted",
"friendName": "Bob Jones",
"friendEmail": "bob@example.com",
"createdAt": "2026-04-05T10:00:00.000Z",
"convertedAt": "2026-04-06T14:30:00.000Z"
},
{
"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",
"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.