CampaignsAdvocates
List advocate activity
Retrieve the activity ledger for a single advocate.
GET /app/campaigns/{campaignId}/advocates/{advocateId}/activity
Returns the activity log for an advocate in reverse-chronological order — enrollment, referrals sent, conversions, and credit adjustments. Results are paginated; use nextToken to retrieve subsequent pages.
Request
See API Basics for required headers.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Number of entries per page (1–200). Defaults to 25. |
nextToken | string | No | Opaque cursor returned by a previous response. Omit to retrieve the first page. |
Sample request
curl "https://api.recomly.com/app/campaigns/c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012/advocates/e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123/activity?limit=25" \
-H "Authorization: Bearer rk_live_abc123:def456"Sample response
Status: 200 OK
{
"activity": [
{
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"advocateId": "e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123",
"campaignId": "c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012",
"activityId": "h2f8d6e4-05g7-4i1h-dfh8-6j8k0l2m3456",
"action": "advocate.credit.adjusted",
"description": "Credit adjusted +$10.00.",
"amountCents": 1000,
"balanceBefore": 2500,
"balanceAfter": 3500,
"memo": "Goodwill credit for campaign participation",
"createdAt": "2026-04-07T11:00:00.000Z"
},
{
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"advocateId": "e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123",
"campaignId": "c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012",
"activityId": "i3g9e7f5-16h8-4j2i-eih9-7k9l1m3n4567",
"action": "advocate.referral.converted",
"description": "Referral converted — Bob Jones became a customer. Earned $25 credit.",
"amountCents": 2500,
"balanceBefore": 0,
"balanceAfter": 2500,
"referralId": "f0d6b4c2-83e5-4g9f-bdf6-4h6i8j0k1234",
"friendName": "Bob Jones",
"createdAt": "2026-04-06T14:30:00.000Z"
},
{
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"advocateId": "e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123",
"campaignId": "c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012",
"activityId": "j4h0f8g6-27i9-4k3j-fji0-8l0m2n4o5678",
"action": "advocate.enrolled",
"description": "Enrolled as a referral advocate.",
"createdAt": "2026-04-04T15:00:00.000Z"
}
],
"nextToken": "eyJQSyI6Ik9SR..."
}nextToken is null when there are no further pages.
Error responses
See API Basics for standard status codes and error response format.
Sample response
Status: 200 OK
{
"activity": [
{
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"advocateId": "e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123",
"campaignId": "c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012",
"activityId": "h2f8d6e4-05g7-4i1h-dfh8-6j8k0l2m3456",
"action": "advocate.credit.adjusted",
"description": "Credit adjusted +$10.00.",
"amountCents": 1000,
"balanceBefore": 2500,
"balanceAfter": 3500,
"memo": "Goodwill credit for campaign participation",
"createdAt": "2026-04-07T11:00:00.000Z"
},
{
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"advocateId": "e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123",
"campaignId": "c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012",
"activityId": "i3g9e7f5-16h8-4j2i-eih9-7k9l1m3n4567",
"action": "advocate.referral.converted",
"description": "Referral converted — Bob Jones became a customer. Earned $25 credit.",
"amountCents": 2500,
"balanceBefore": 0,
"balanceAfter": 2500,
"referralId": "f0d6b4c2-83e5-4g9f-bdf6-4h6i8j0k1234",
"friendName": "Bob Jones",
"createdAt": "2026-04-06T14:30:00.000Z"
},
{
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"advocateId": "e9c5a3b1-72d4-4f8e-ace5-3g5h7i9j0123",
"campaignId": "c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012",
"activityId": "j4h0f8g6-27i9-4k3j-fji0-8l0m2n4o5678",
"action": "advocate.enrolled",
"description": "Enrolled as a referral advocate.",
"createdAt": "2026-04-04T15:00:00.000Z"
}
]
}Error responses
See API Basics for standard status codes and error response format.