---
title: "Get Customer Redemptions"
method: GET
path: "/customer/redemptions"
---

# Get Customer Redemptions

`GET /customer/redemptions`

This API allows you to retrieve points and coupons redemption history of a customer. You can filter the results by type, duration, coupon ids start with, and coupon ids end with. Besides filters you can also sort the results by ascending or descending order by redemption id/time and limit number of results to retrieve.

## Query parameters

- `identifierName` 'mobile' | 'email' | 'external_id id', required
- `identifierValue` string, required
- `type` 'POINTS' | 'COUPONS' | 'BOTH'
- `start_date` string, date
- `end_date` string, date
- `entity_code` string
- `coupons_limit` integer
- `points_limit` integer
- `limit` integer
- `coupons_start_id` integer
- `coupons_end_id` integer
- `points_start_id` integer
- `points_end_id` integer
- `sort` 'redemption_id' | 'redeemed_time'
- `order` 'asc' | 'desc'
- `mlp` boolean
- `format` 'xml' | 'json'
- `user_id` boolean
- `merchant_store_id` integer
- `order` 'asc' | 'desc'
- `program_id` integer

## Response `200`

200

- object
  - `response` object
    - `status` object
      - `success` boolean
      - `code` integer
      - `message` string
    - `customer` object
      - `mobile` string
      - `email` string
      - `external_id` string
      - `firstname` string
      - `lastname` string
      - `user_groups2` unknown[]
        - unknown
      - `rows` integer
      - `coupons_count` unknown
      - `points_count` integer
      - `coupons_start_id` string
      - `points_start_id` integer
      - `redemptions` object
        - `coupons` object
          - `coupon` unknown
        - `points` object
          - `point` object[]
            - `id` integer
            - `program_id` integer
            - `points_redeemed` integer
            - `transaction_number` string
            - `bill_id` string
            - `validation_code` string
            - `redeemed_time` string
            - `redeemed_at` string
            - `redemption_purpose` string
            - `notes` string
            - `external_reference_number` string
            - `redemption_id` string
            - `redeemed_store` object
              - …
            - `redeemed_till` object
              - …
            - `custom_fields` object
              - …
            - `reversals` unknown[]
              - …
            - `redemption_breakup_by_program` unknown[]
              - …

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/versions/de241f2ed9b3/schema)