---
title: "Get redemption List"
method: GET
path: "/api-offers/redemptions"
tags: ["Redemption"]
---

# Get redemption List

`GET /api-offers/redemptions`

## Request

- Base URL: `https://live.copilot.fabric.inc`
- URL: `https://live.copilot.fabric.inc/api-offers/redemptions`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/fabric/apis/offers-v2/docs/api-offers/redemptions/get.ts> (a function with typed inputs; its response is checked against the schema)

Enables you to get a paginated redemption list.

## Query parameters

- `size` number
- `startCursor` string, nullable
- `promoId` string
- `promoCode` string
- `userId` string
- `email` string
- `orderId` string
- `storeId` string
- `status` 'ACTIVE' | 'INACTIVE'
- `redeemedFrom` string, date-time
- `redeemedTo` string, date-time
- `updatedFrom` string, date-time
- `updatedTo` string, date-time
- `title` string
- `isImplicit` boolean
- `singleMultiUse` 'MULTI_USE' | 'SINGLE_USE'
- `additionalAttributes` string
- `promoAdditionalAttributes` string

## Headers

- `x-site-context` string, required

## Response `200`

OK

- ListRedemptionResponse
  - `query` GenericListQueryResponse: Paging details used for selecting list
    - `limit` number: The maximum number of records per page.
    - `count` number: The total number of records.
    - `offset` number: The number of records to skip before returning records. For example, when offset is 20 and limit is 10, this endpoint returns records from 21 to 30.
  - `data` Redemption[]: Segment information.
    - `_id` string: fabric internal ID
    - `promoId` string: fabric database objectId of the promotion to redeem
    - `promoCode` string: promoCode of the coupon that is redeemed
    - `userId` string: ID of the user who redeem the coupon
    - `email` string: Email address of the user who redeem the coupon
    - `orderId` string: Order ID of this purchase
    - `createdAt` string, date-time: Creation date of the record
    - `updatedAt` string, date-time: Last updated date of the record

## Other responses

- `400`: Bad Request.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/fabric/apis/offers-v2.md) - [All operations](https://skmtc.dev/fabric/apis/offers-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/fabric/apis/offers-v2/revisions/da2bd742b9bc?raw)