---
title: "Retrieve a comprehensive list of rewards for a specified customer."
method: GET
path: "/api/v1alpha1/customers/{customerId}/rewards"
tags: ["RewardsService"]
---

# Retrieve a comprehensive list of rewards for a specified customer.

`GET /api/v1alpha1/customers/{customerId}/rewards`

This endpoint is designed to provide a detailed inventory of all rewards generated for a consumer.

Each entry in the list includes pertinent information about a reward, along with its current status (e.g., unavailable, available, used, expired).

Utilize the queryString parameter "pageSize" to define the list size, with a default limit set to 100 items. If no value is specified, our system will assume the default.

In case there are additional items yet to be retrieved, the response will include a pageToken. Include this token in your subsequent request's pageToken field to fetch the next set of items. It is crucial to note that if you modify any queryString parameters, the initial request should not contain a pageToken.

## Path parameters

- `customerId` string, required

## Query parameters

- `pageSize` integer
- `pageToken` string
- `storeId` string

## Headers

- `Brand` string, required

## Response `200`

A successful response.

- V1alpha1ListCustomerRewardsResponse
  - `rewards` ListCustomerRewardsResponseRewards[] — List of rewards used for cashback value.
    - `reward` Corev1alpha1Reward
      - `id` integer — ID of the reward.
      - `dueDate` string, date-time — Reward expiration date.
      - `value` string — Maximum amount to be redeemed for the reward.
      - `rate` integer — Maximum percentage of the purchase value that the reward value can be applied to.
      - `status` string — Informs the status of the reward. It can be available, locked, used, expired and undefined.
      - `availableAt` string, date-time — Reward available date.
      - `createdAt` string, date-time — Reward create date.
      - `balance` string — Balance available to be redeemed.
      - `canceledAt` string, date-time — Reward cancel date.
      - `extraInformation` V1alpha1ExtraInformation
        - `orderId` string — OrderID is the ID that identifies the purchase transaction that generated the reward.
        - `storeId` string — StoreID is the ID of the store where the purchase comes from.
    - `campaign` V1alpha1Campaign
      - `id` integer — ID of the campaign that generated the reward.
      - `name` string — Name of the campaign that generated the reward.
      - `description` string — Description of the campaign that generated the reward.
  - `nextPageToken` string

## Other responses

- `400` — When an invalid request is sent.
- `401` — When the authentication is failed.
- `403` — when it was not authorized.
- `default` — An unexpected error response.

---

[API](https://skmtc.dev/dito/apis/authentication-api.md) · [All operations](https://skmtc.dev/dito/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dito/authentication-api/revisions/de4a5e2a412f/schema)