Profiles
Get reward redemption status
Returns the current state of a pending or completed reward redemption for the authenticated consumer. Supply exactly one of polling_id (returned by a prior reward claim call), reward_name (the configured reward name), or partner_event_id (the originating partner event identifier). Poll this endpoint until the reward reaches a terminal state.
get/api/v4/me/rewards/status
Request
- Base URLhttps://api.extole.io
- Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
polling_idstring
Polling identifier returned by the reward claim call.
reward_namestring
The configured name of the reward to look up.
partner_event_idstring
The partner-supplied event identifier that originated the reward.
Response
Reward redemption status.
Example response
{
"reward": {
"created_at": "2025-10-24T02:00:00-07:00",
"expires_at": "2025-10-24T02:00:00-07:00"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.