Get redemption

Fetch a single reward redemption by its id, scoped to your company.
Returns the redemption's state, catalog/reward details, and claim and
certificate URLs — the same shape as the /api/v1/redemptions/:id
endpoint.

Input:

  • id (string, required) — the redemption's (reward's) BSON ObjectId.

You can read your OWN redemptions; reading someone else's requires a
rewards-admin role. A redemption that doesn't exist in your company —
or that you're not allowed to see — is reported as not found.

Required OAuth scope: rewards:read or rewards:administer

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
Allowed:
string
enum
required
Allowed:
params
object
required
string
required
Responses

401

Unauthorized

403

Forbidden

Language
Credentials
Bearer
OAuth2 access token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json