> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yuko.so/llms.txt
> Use this file to discover all available pages before exploring further.

# List customer rewards

Retrieves a paginated list of redeemed rewards (coupons, discounts, store credits) for a customer. Results are sorted by `created_at` in descending order.

**GET /public/customers/rewards**

#### **Authorizations**

**Authorization**

**string**

**header**

**required**

Bearer authentication header of the form `Bearer <token>`, where `<token>` is your REST API token.

#### **Required Scope**

**`rewards:read`**

This endpoint requires the `rewards` scope with **Read Access**. Configure token scopes in Settings → Integrations → REST API.

#### **Query Parameters**

**customer\_id**

**string**

**required**

The platform customer ID (e.g. Shopify customer ID)

Example:

`"9049402769586"`

#### **Query Parameters**

**status**

**enum\<string>**

Filter results to only rewards matching the provided status.

Available options:

`active`,

`used`,

`inactive`,

`expired`,

`deleted`,

`revert`

**per\_page**

**integer**

**default: 20**

The number of results per page.

Required range: `1 <= x <= 100`

**page**

**integer**

**default: 1**

The page number to retrieve.

#### **Response**

**200 - application/json**

**data**

**object\[]**

Hide child attributes

**data.id**

**string\<uuid>**

Unique UUID identifier for the customer reward.

Example:

`"1fd80ced-326f-4082-951b-21a38632a603"`

**data.customer\_id**

**string\<uuid>**

The UUID of the customer this reward was issued to.

Example:

`"63a2c89a-9936-4bc0-9d5f-93db46110b76"`

**data.reward\_id**

**string\<uuid> | null**

The UUID of the loyalty reward definition that generated this reward.

Example:

`"90424fa7-e8a9-4ef4-b43a-72c9b2028db5"`

**data.reward\_type**

**string | null**

The type of reward issued.

Available options:

`fixed_discount`,

`percentage_discount`,

`free_shipping`,

`free_product`,

`store_credit`

Example:

`"fixed_discount"`

**data.status**

**enum\<string>**

The current status of this reward.

Available options:

`active`,

`used`,

`inactive`,

`expired`,

`deleted`,

`revert`

Example:

`"used"`

**data.discount\_code**

**string | null**

The discount or coupon code issued to the customer.

Example:

`"YUKO-TVJ-BL1"`

**data.points\_used**

**integer**

The number of loyalty points spent to generate this reward.

Example:

`500`

**data.expires\_at**

**string\<date-time> | null**

The date and time when this reward expires. `null` if it does not expire.

Example:

`"2026-06-01T00:00:00.000Z"`

**data.used\_at**

**string\<date-time> | null**

The date and time when the reward was used. `null` if not yet used.

Example:

`"2026-02-20T14:22:00.000Z"`

**data.created\_at**

**string\<date-time>**

The date and time when the reward was issued.

Example:

`"2026-02-15T08:30:00.000Z"`

**meta**

**object**

Hide child attributes

**meta.pagination**

**object**

Pagination details for the result set.

Hide child attributes

**meta.pagination.current\_page**

**integer**

Example:

`1`

**meta.pagination.per\_page**

**integer**

Example:

`20`

**meta.pagination.total**

**integer**

Example:

`5`

**meta.pagination.last\_page**

**integer**

Example:

`1`

**meta.pagination.has\_more**

**boolean**

Example:

`false`

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url "https://api.yukoapp.com/api/v1/public/customers/rewards?customer_id=9049402769586?status=active&per_page=20" \
    --header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  ```

  ```javascript JavaScript theme={null}
  const customerId = "9049402769586";
  const params = new URLSearchParams({ status: "active", per_page: 20 });

  const response = await fetch(
    `https://api.yukoapp.com/api/v1/public/customers/rewards?customer_id=${customerId}?${params}`,
    {
      method: "GET",
      headers: {
        Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      },
    }
  );

  const data = await response.json();
  ```

  ```php PHP theme={null}
  $customerId = "9049402769586";
  $query = http_build_query(["status" => "active", "per_page" => 20]);

  $ch = curl_init();
  curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/customers/rewards?customer_id={$customerId}?{$query}");
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  $data = json_decode($response, true);
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "data": [
      {
        "id": "1fd80ced-326f-4082-951b-21a38632a603",
        "customer_id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
        "reward_id": "90424fa7-e8a9-4ef4-b43a-72c9b2028db5",
        "reward_type": "fixed_discount",
        "status": "active",
        "discount_code": "YUKO-TVJ-BL1",
        "points_used": 500,
        "expires_at": "2026-06-01T00:00:00.000Z",
        "used_at": null,
        "created_at": "2026-02-15T08:30:00.000Z"
      }
    ],
    "meta": {
      "pagination": {
        "current_page": 1,
        "per_page": 20,
        "total": 1,
        "last_page": 1,
        "has_more": false
      }
    }
  }
  ```

  ```json 404 theme={null}
  {
    "error": {
      "code": "not_found",
      "message": "Customer not found"
    }
  }
  ```

  ```json 401 theme={null}
  {
    "error": {
      "code": "invalid_token",
      "message": "Invalid or revoked API token"
    }
  }
  ```
</ResponseExample>
