---
title: "List Reward Assignments"
method: GET
path: "/v1/rewards/{rewardId}/assignments"
tags: ["Rewards"]
---

# List Reward Assignments

`GET /v1/rewards/{rewardId}/assignments`

Retrieve reward assignments by the reward ID.

## Query parameters

- `limit` integer
- `page` integer

## Response `200`

Returns a dictionary of reward assignment objects. Each object contains information regarding the resource to which the reward was assigned and the cost in loyalty points for the reward.

- RewardsAssignmentsListResponseBody — Response body schema for **GET** `v1/rewards/{rewardID}/assignments`.
  - `object` string, required — The type of the object represented by JSON. This object stores information about reward assignments in a dictionary.
  - `data_ref` string, required — Identifies the name of the attribute that contains the array of reward assignments.
  - `data` RewardAssignment[], required
    - `id` string, required — Unique reward assignment ID, assigned by Voucherify.
    - `reward_id` string, required — Associated reward ID.
    - `created_at` string, date-time, required — Timestamp representing the date and time when the reward assignment was created. The value is shown in the ISO 8601 format.
    - `updated_at` string, date-time, nullable, required — Timestamp representing the date and time when the reward assignment was updated. The value is shown in the ISO 8601 format.
    - `object` 'reward_assignment', required — The type of the object represented by the JSON. This object stores information about the reward assignment.
    - `related_object_id` string, required — Related object ID to which the reward was assigned.
    - `related_object_type` 'campaign', required — Related object type to which the reward was assigned.
    - `parameters` object — Defines the cost of the reward.
      - `loyalty` object, required — Defines the equivalent points value of the reward.
        - `points` integer — The number of points required to redeem the reward.
        - `auto_redeem` boolean, nullable — Determines if the reward is redeemed automatically when the customer reaches the sufficient number of points to redeem it. Value `true` means that the automatic reward redemption is active. Only one reward can be set to be redeemed automatically in a loyalty campaign, i.e. only one can have the value `true`.
  - `total` integer, required — Total number of reward assignments.

## Other responses

- `404` — Returns an error if the given reward is missing, does not exist or was deleted.

---

[API](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions.md) · [All operations](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voucherifyio/voucherify-api-async-actions/revisions/4982266e0494/schema)