---
title: "List Campaign Rewards"
method: GET
path: "/v1/loyalties/{campaignId}/rewards"
tags: ["Loyalties"]
---

# List Campaign Rewards

`GET /v1/loyalties/{campaignId}/rewards`

## Request

- Base URL: `https://api.voucherify.io`
- URL: `https://api.voucherify.io/v1/loyalties/{campaignId}/rewards`
- Auth: one of:
  - API key in header `X-App-Id` and API key in header `X-App-Token`
  - OAuth 2
    - Implicit: `https://api.voucherify.io/v1/oauth/token`
    - Scopes: `api`, `loyalties`

Returns active rewards from a given loyalty campaign.

## Query parameters

- `limit` integer
- `page` integer
- `assignment_id` string

## Response `200`

Returns a dictionary with reward assignment objects.

- LoyaltiesRewardsListAssignmentsResponseBody: Response body schema for **GET** `v1/loyalties/{campaignId}/rewards`.
  - `object` 'list': The type of the object represented by JSON. This object stores information about loyalty reward assignments in a dictionary.
  - `data_ref` string: Identifies the name of the attribute that contains the array of reward assignment objects.
  - `data` RewardAssignment[]: Contains array of reward assignment objects.
    - `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: Total number of reward assignment objects.

---

[API](https://skmtc.dev/voucherifyio/apis/voucherify-api-async-actions.md) - [All operations](https://skmtc.dev/voucherifyio/apis/voucherify-api-async-actions/llms.txt) - [OpenAPI document](https://skmtc.dev/voucherifyio/apis/voucherify-api-async-actions/revisions/4982266e0494?raw)