Recomly APIEndpoints
Get campaign
Retrieve a single referral campaign by ID.
GET /api/app/campaigns/{campaignId}
Returns a single campaign. Deleted campaigns return 404.
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 \
-H "Authorization: Bearer rk_live_abc123:def456"Sample response
Status: 200 OK
{
"campaign": {
"campaignId": "c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012",
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"name": "Spring Referral Drive",
"status": "active",
"rewardMode": "fixed",
"advocateRewardValue": 2500,
"friendRewardValue": 1500,
"maxReferralsPerAdvocate": 20,
"createdAt": "2026-04-04T14:00:00.000Z",
"updatedAt": "2026-04-04T14:00:00.000Z"
}
}Error responses
See API Basics for standard status codes and error response format.