Recomly APIEndpoints
List campaigns
Retrieve all referral campaigns for your organization.
GET /api/app/campaigns
Returns all active and paused campaigns for your organization. Deleted campaigns are not included.
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 \
-H "Authorization: Bearer rk_live_abc123:def456"Sample response
Status: 200 OK
{
"campaigns": [
{
"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"
},
{
"campaignId": "d8b4e2c1-93c1-4f0b-ace3-2e4f6b8d0123",
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"name": "Summer Percent Campaign",
"status": "paused",
"rewardMode": "percent",
"advocateRewardValue": 500,
"friendRewardValue": 300,
"maxReferralsPerAdvocate": 10,
"expiresAt": "2026-08-31T23:59:59.000Z",
"createdAt": "2026-03-01T09:00:00.000Z",
"updatedAt": "2026-03-15T11:30:00.000Z"
}
]
}Error responses
See API Basics for standard status codes and error response format.