---
title: "List Issued Rewards"
method: GET
path: "/api/v1/rewards"
tags: ["Rewards"]
---

# List Issued Rewards

`GET /api/v1/rewards`

## Request

- Base URL: `https://merchant-api.accruesavings.com`
- URL: `https://merchant-api.accruesavings.com/api/v1/rewards`
- Auth: none declared. Required headers: `Client-ID`, `Authorization`
- TypeScript: <https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/rewards/get.ts> (a function with typed inputs; its response is checked against the schema)

List rewards issued to a recipient. Returns a paginated list of unified `Reward` resources that may include both immediate credits and pre-issued rewards. `filter[phoneNumber]` is required. When `filter[status]` is provided, only pre-issued rewards matching that status are returned.

## Query parameters

- `filter[phoneNumber]` string: Recipient phone number to look up (required).
- `filter[status]` string: When set, filters to pre-issued rewards with this status only (`Created`, `Claimed`, `Expired`, or `Cancelled`).
- `page[limit]` number: Maximum number of objects that will be returned. Can not be greater than 50.
- `page[offset]` number: Offset from the beginning of the list of objects. Can not be negative.

## Headers

- `Client-ID` string, uuid, required: The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.
- `Authorization` string, uuid, required: Secure secret to access privileged endpoints.

## Response `200`

OK

- ListIssuedRewardsResponse
  - `data` RewardResponse[], required
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'Reward', required
    - `attributes` object, required
      - `kind` 'immediate' | 'preIssued', required: Informational discriminator only. Use `canUpdate` and `canCancel` to decide which operations are allowed — do not branch behavior on `kind` alone.
      - `amount` integer, required: Reward amount in cents.
      - `walletId` string, uuid, nullable, required: Wallet that received the reward. Set for immediate credits; `null` for pre-issued rewards awaiting claim.
      - `status` 'Credited' | 'Created' | 'Claimed' | 'Expired' | 'Cancelled', required: Unified lifecycle status. Immediate wallet credits are `Credited`; pre-issued rewards use `Created`, `Claimed`, `Expired`, or `Cancelled`.
      - `canUpdate` boolean, required: Whether `PATCH /api/v1/rewards/{id}` is allowed for this reward.
      - `canCancel` boolean, required: Whether `DELETE /api/v1/rewards/{id}` is allowed for this reward.
      - `claimExpiresAt` string, date-time, nullable, required: When a pre-issued reward must be claimed before it expires. `null` for immediate wallet credits.
      - `message` string, nullable, required: Optional message attached to the reward.
      - `reasonCode` string, nullable, required: Partner-defined reason code for reporting and reconciliation.
      - `costCenter` string, nullable, required: Partner-defined cost center for reporting.
      - `notificationEmail` string, email, nullable, required: Email address to notify when a pre-issued reward is claimed.
  - `meta` object, required
    - `total` number, required
    - `limit` number, required
    - `offset` number, required

## Other responses

- `400`: Validation error
- `500`: Internal Server Error

---

[API](https://skmtc.dev/byaccrue/apis/accrue-merchant-api.md) - [All operations](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/revisions/3e2d97ef2e6e?raw)