Developers
V1RewardsCampaigns

Published welcome campaigns with your own claim status when signed in

One claim per account and campaign, not one per person. No health, step or IC data is required. Nothing is published by default.

GET
/v1/rewards/campaigns

Response Body

application/json

curl -X GET "https://example.com/v1/rewards/campaigns"
{  "campaigns": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "merchantTenantId": "6f45c064-68ad-43e0-92dc-fa8655333cff",      "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",      "title": "string",      "summary": "string",      "rules": "string",      "deliveryKind": "physical_gift",      "startsAt": "2019-08-24T14:15:22Z",      "endsAt": "2019-08-24T14:15:22Z",      "redeemBy": "2019-08-24T14:15:22Z",      "timezone": "string",      "reservationTtlSeconds": 1,      "requiresVerifiedIdentity": true,      "imagePath": "string",      "claimPolicy": "per_merchant",      "claimRestricted": true,      "limitBasis": "account",      "availableStock": 0,      "availability": "upcoming",      "ownClaim": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",        "deliveryKind": "physical_gift",        "status": "reserved",        "reservedAt": "2019-08-24T14:15:22Z",        "expiresAt": "2019-08-24T14:15:22Z",        "redeemedAt": "2019-08-24T14:15:22Z"      }    }  ]}

Workspace operational analytics with a fresh password session and live platform admin role GET

Malaysia calendar dates, at most 366 days; the window preserves selected dates and daily rows omit future dates. Current membership, invitation and stock counts use report time, independent of the selected period. Period counts use membership join/end timestamps, invitation creation/acceptance timestamps, and claims reserved in the period. Invitation and claim cohort outcomes are mutually exclusive as of report time, not period end. Daily claim outcomes are grouped by claim reservation date. Membership history is the latest stored membership edge, not a complete rejoin ledger; deleted and pending-deletion accounts are excluded. No employee identities, health values, health participation, app activity, or individual sharing status are returned. MC operational totals are available only to the current corporate workspace owner or HR admin through the partner endpoint. They include requests explicitly submitted with valid sharing consent, exclude drafts and departed/deleted employees, and count submitted, approved, rejected and withdrawn requests. Calendar-day totals count inclusive overlap with the full selected dates, including future dates; they do not establish entitlement or predict absence. Platform endpoints never include MC totals.

Reserve one configured welcome reward as yourself POST

Reuse claimId on retry. An existing account/campaign claim is returned, including after expiry; a second UUID cannot reserve another unit. Expired unfulfilled leases release inventory automatically. Identity-required campaigns fail closed until a verified workflow exists; OCR or icHash never qualifies.