API ReferenceRewards
List rewards
Authorization
apiKey AuthorizationBearer <token>
In: header
Query Parameters
status?string
Value in
- "CREATED"
- "SENT"
- "OPENED"
- "PARTIALLY_REDEEMED"
- "REDEEMED"
- "EXPIRED"
- "CANCELED"
external_id?string
page?integer
Range
1 <= valueDefault
1page_size?integer
Range
1 <= value <= 100Default
25Response Body
application/json
curl -X GET "https://example.com/v1/rewards"{ "rewards": [ { "id": "string", "type": "FIXED", "status": "string", "faceValueCents": 0, "remainingValueCents": 0, "currency": "string", "recipientEmail": "string", "recipientFirstName": "string", "recipientLastName": "string", "message": "string", "utid": "string", "allowedBrandKeys": [ "string" ], "campaign": "string", "externalId": "string", "source": "string", "expiresAt": "string", "sentAt": "string", "openedAt": "string", "redeemedAt": "string", "createdAt": "string", "brandName": "string", "brandImageUrl": "string", "issuedCards": [ { "id": "string", "utid": "string", "rewardName": "string", "amountCents": 0, "currency": "string", "status": "string", "redemptionInstructions": "string", "issuedAt": "string", "createdAt": "string", "brandName": "string", "brandImageUrl": "string", "credentials": [ { "label": "string", "value": "string", "type": "string" } ] } ], "events": [ { "id": "string", "type": "string", "metadata": { "property1": null, "property2": null }, "createdAt": "string" } ] } ], "total": 0, "page": 0, "pageSize": 0}