---
title: "Get customer rewards"
method: POST
path: "/api/merchant/v2/customers/rewards"
tags: ["Customers"]
---

# Get customer rewards

`POST /api/merchant/v2/customers/rewards`

Returns all rewards a customer has been given.

Rewards that are fulfilled outside of Mention Me will not be returned.

**Scopes:** `customers:read`, `rewards:read`

**Rate limits:** 300 requests per 5 minutes. Shared across all 'rewards' endpoints.

## Request body

- CustomerEmailIdentifierInput — A customer email address.
  - `identifier` CustomerEmailIdentifier, required
    - `type` 'email', required — The type of identifier.
    - `value` string

## Response `200`

The rewards issued to the customer matching the identifier.

- CustomerRewardsOutput — An object representing the customer and the rewards they were given
  - `data` CustomerRewardsPayload
    - `customer` CustomerEssentialsPayload — The profile of a customer
      - `customerId` string — The ID of the customer generated by your system.
      - `email` string
      - `firstname` string
      - `surname` string
      - `phoneNumbers` string[]
      - `profileUrl` string
    - `rewards` RewardablePayload[]
      - `id` integer
      - `fulfilledBy` string
      - `amount` number, float
      - `description` string
      - `type` 'amount' | 'description' | 'number' | 'percent'
      - `beforePurchase` boolean
      - `minimumFriendsRequired` integer, nullable
      - `spendConstraint` number, float — The minimum spend required to receive the reward.
      - `callToActionUrl` string — The URL that the customer should be directed to after redeeming the reward. This is usually a link to an online store, or other means of using the reward.
      - `couponCode` string — If the issued reward is a coupon code, the code the customer should use to redeem the reward.
      - `couponLink` string — If the issued reward is a coupon link, the link the customer should use to redeem the reward.
      - `securityCode` string — An additional security code or PIN for using the reward.
      - `expiryDate` string, date-time — The date the reward expires.

## Other responses

- `401` — Required scopes are missing.
- `404` — No customers matched the identifier.
- `429` — Rate limit exceeded.

---

[API](https://skmtc.net/mention-me/apis/auth-api.md) · [All operations](https://skmtc.net/mention-me/apis/auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mention-me/auth-api/revisions/cdad84f071bd/schema)