RewardCampaignService
List My Reward Awards
List published campaign awards for the authenticated root account. Requires a session token.
Request
curl --request GET \ \ --url 'https://api.testnet.polyester.com/v1/rewards/awards?limit=100' \ --header 'Accept: */*' \ --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \ --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \ --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'
Responses
{
"awards": [
{
"amountBaseUnits": "123.45",
"assetId": 100,
"awardId": "value",
"campaignId": "value",
"campaignName": "value",
"destinationAddress": "0x3333333333333333333333333333333333333333",
"fulfillmentMethod": "EXTERNAL_TESTNET",
"fulfillmentRevision": "1",
"fulfillmentState": "AWAITING_DESTINATION",
"network": "value",
"publishedAt": "2025-01-01T00:00:00Z",
"transactionId": "value"
}
],
"awardsMayChange": false,
"nextPageToken": "eyJvZmZzZXQiOjIwMH0"
}Maximum awards to return. Zero uses 50; maximum 100.
Opaque exclusive continuation token bound to the authenticated root account.
Stable opaque award identifier.
valueStable campaign identifier.
valueCampaign display name frozen at publication.
valueCanonical asset identifier.
100Exact integer amount in the asset's smallest base unit.
123.45Selected delivery method.
EXTERNAL_TESTNETCurrent delivery state.
AWAITING_DESTINATIONPublication time.
2025-01-01T00:00:00ZCampaign payout network. Interpret destination_address in this network.
valueCurrent fulfillment revision for optimistic concurrency.
1Recipient payout destination once submitted. Empty until provided.
0x3333333333333333333333333333333333333333External transaction identifier once staff records delivery. Empty until delivered.
valueOpaque continuation token. Empty when no more results exist.
eyJvZmZzZXQiOjIwMH0True while a campaign can still publish new awards, or while one of this account's awards is awaiting a destination, ready for payout, or failed and may be retried. When false, repeated polling cannot return new awards or award changes until a new campaign is created; check again on the next page load or focus.
false| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| unauthenticated | 401 | unauthenticated | Unauthenticated | Authentication required. |
| permission-denied | 403 | permission_denied | Permission Denied | Permission denied. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Unavailable | Service unavailable. |