List Widget Referrals
The referrals where the participant that the Widget token names is the referrer, in one referral Program of the Project of the token, newest first. The token needs the widget:read scope. A participant that the Project does not have gets an empty list; the route creates no participant. A Program of another Project, or an affiliate or loyalty Program, gets 404 NOT_FOUND; a cursor that is not valid gets 400 INVALID_REQUEST. The response is not cached (Cache-Control: private, no-store).
Authorization
WidgetJWT HS256 with typ refref-widget+jwt, iss and projectId equal to Project ID, aud refref-widget, sub the external ID of the participant, participantKind its kind (individual or group), mandatory iat and exp, lifetime at most 900 seconds. scope lists one or more Widget scopes separated by one space; widget:read gives Widget init and the payout details read, and widget:payout gives the payout details save, for example "widget:read widget:payout". A token without the scope of an operation gets 403. Signed by the Project backend with its secret.
In: header
Query Parameters
\S1 <= length <= 512\S1 <= length <= 5121 <= length <= 20481 <= value <= 5020Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/widget/referrals?projectId=string&programId=string"{ "items": [ { "id": "string", "date": "string", "label": "string", "status": "joined", "rewardCount": 0 } ], "nextCursor": "string"}List Webhook Events GET
Webhook events in commit order after the cursor. A late commit never appears behind a cursor, so a product that missed webhooks catches up from its last next. The webhooks section lists each event type and its data.
List Widget Rewards GET
The Rewards that credit the participant that the Widget token names, in one referral Program of the Project of the token, newest first, each with its Widget status. The token needs the widget:read scope. The first page (no cursor) has the summary. A participant that the Project does not have gets an empty list; the route creates no participant. A Program of another Project, or an affiliate or loyalty Program, gets 404 NOT_FOUND; a cursor that is not valid gets 400 INVALID_REQUEST. The response is not cached (Cache-Control: private, no-store).