Skip to main content
GET
/
customer
/
api
/
open
/
v1
/
loyalty
/
rewards
/
{rewardOptionId}
/
redeemers
Get redeemers for one reward option
curl --request GET \
  --url https://api.bitbybit.studio/customer/api/open/v1/loyalty/rewards/{rewardOptionId}/redeemers \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "redemptionId": "<string>",
      "reward": {
        "id": "<string>",
        "name": "<string>"
      },
      "customer": {
        "id": "<string>",
        "companyId": 123,
        "name": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>"
      },
      "pointsSpent": "<string>",
      "status": "<string>",
      "source": "<string>",
      "redeemedAt": "2023-11-07T05:31:56Z",
      "usedAtCheckoutAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "hasMore": true,
    "nextBefore": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://knowledge.bitbybit.studio/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

API key for authentication. Create one in Settings > Developer.

Path Parameters

rewardOptionId
string
required

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
before
string<date-time>
status
enum<string>
Available options:
reserved,
committed,
released,
expired,
failed

Response

200 - application/json

Success

data
object[]
pagination
object