Recomly APIEndpoints
List advocates
Retrieve all advocates enrolled in a campaign.
GET /api/app/campaigns/{campaignId}/advocates
Returns all advocates enrolled in a campaign, with their pending and converted referral counts.
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 \
-H "Authorization: Bearer rk_live_abc123:def456"Sample response
Status: 200 OK
{
"advocates": [
{
"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",
"pendingCount": 2,
"convertedCount": 1
}
]
}Error responses
See API Basics for standard status codes and error response format.