Get Redeemed Rewards

This endpoint allows you to retrieve the history of redeemed rewards in your organization. You can filter by specific reward ID or customer ID.

Authentication

To access this endpoint, you must include an Authorization header with your API key:

Authorization: YOUR_API_KEY

Endpoint

GET /api/v1/getRedeemedRewards

Query Parameters

• rewardId (string, optional) - Filter results by specific reward ID
• customerId (string, optional) - Filter results by specific customer ID

Response

Success Response (200 OK)

{
  "redeemedRewards": [
    {
      // Reward redemption transaction details
    }
  ]
}

Error Responses

• 400 Bad Request

  {
    "error": "Invalid query parameters",
    "details": {
      // Validation error details
    }
  }
  

  • When the query parameters are invalid

• 403 Forbidden

  {
    "error": "No API Key in quest"
  }
  

  • When no API key is provided
  • When the API key is invalid
  • When the endpoint is not allowed with your current subscription plan

• 405 Method Not Allowed

  {
    "error": "Invalid quest method"
  }
  

  • When using a method other than GET

• 429 Too Many Requests

  {
    "error": "You have reached the quest limit per minute. Please slow down tiger."
  }
  

  • When you've exceeded your plan's rate limit

• 500 Internal Server Error

  {
    "error": "An unexpected error occurred",
    "details": "Error message"
  }
  

Rate Limits

Rate limits vary by subscription plan:

• Starter Plan: 10 API calls per minute
• Grow Plan: 100 API calls per minute
• Pro Plan: 500 API calls per minute
• Enterprise Plan: Unlimited API calls

Notes

• Results are filtered by your organization ID automatically
• You can combine rewardId and customerId filters to get more specific results
• The endpoint returns an array of reward redemption transactions
• Transaction history includes details about each reward redemption