---
title: "Generates a summary of redemptions made by all users."
method: GET
path: "/v1/analytics/financial/redemptions"
---

# Generates a summary of redemptions made by all users.

`GET /v1/analytics/financial/redemptions`

Date rules:
<ul>
  <li>If you do not specify a start or end date, it will generate a report of the first of the current month to present.</li>
  <li>If you specify a start date and an end date, they cannot span more than a year.</li>
  <li>If you specify a start date without an end date, it will fetch either a month from start date, or the current day. Whichever is less.</li>
  <li>If you specify an end date without a start date, it will error.</li>
</ul>
All requests will include the applied start and end date.

## Query parameters

- `expand` string[]
- `sort` 'gift_card_redemptions' | 'swag_redemptions' | 'amazon_us' | 'amazon_uk' | 'amazon_ca'
- `start-date` string, date
- `end-date` string, date

## Response `200`

OK

- object
  - `status` 'success'
  - `links` Links
    - `self` string, uri
    - `related` object[]
      - `type` string
      - `href` string, uri
  - `data` object
    - `meta` object
      - `startDate` string, date
      - `endDate` string, date
      - `total` string
    - `financialRedemptionReport` object[]
      - `gift_card_redemptions` string
      - `swag_redemptions` string
      - `amazon_redemptions` object
        - `US` string
        - `UK` string
        - `CA` string
      - `user` union
        - BaseUser
          - `id` string
          - `email` string, email
          - `employee_id` string, nullable
          - `first_name` string
          - `last_name` string
          - `username` string
          - `phone_number` string, nullable
          - `department` string, nullable
          - `office_location` string, nullable
          - `job_title` string, nullable
          - `language` string, nullable
          - `active` boolean
          - `invite_email_sent` boolean — Indicates whether an invite email was sent for this user during this request. Only present in PUT responses. Returns true when the send_invites query parameter is present and user_invited is true in the request body for this user.
          - `self` string, uri
          - `related` object[]
            - `type` string
            - `href` string, uri
        - ExpandedUser
          - `id` string
          - `email` string, email
          - `employee_id` string, nullable
          - `first_name` string
          - `last_name` string
          - `username` string
          - `phone_number` string, nullable
          - `department` string, nullable
          - `office_location` string, nullable
          - `job_title` string, nullable
          - `language` string, nullable
          - `active` boolean
          - `invite_email_sent` boolean — Indicates whether an invite email was sent for this user during this request. Only present in PUT responses. Returns true when the send_invites query parameter is present and user_invited is true in the request body for this user.
          - `self` string, uri
          - `related` object[]
            - `type` string
            - `href` string, uri
          - `user_role` 'Administrator' | 'Manager' | 'Employee'
          - `preferred_name` string, nullable
          - `birth_date` string, nullable
          - `hire_date` string, date, nullable
          - `inactive_date` string, date, nullable
          - `user_invited` boolean
          - `user_onboarded` boolean
          - `manager_email` string, email, nullable
          - `workspaces` string[]
          - `giveable_points` number
          - `redeemable_points` number
          - `logged_in_once` boolean
          - `custom_properties` object

## Other responses

- `400` — `BAD REQUEST`: Body or Query Params are malformed (missing, extra, or invalid values)
- `401` — `UNAUTHORIZED`: Request was sent with an expired or missing API Key
- `403` — `FORBIDDEN`: Request was authenticated but the resource requested is missing or not accessible with that key
- `404` — `NOT FOUND`: The requested resource was not found
- `429` — `TOO MANY REQUESTS`: Company is being rate limited
- `500` — `INTERNAL SERVER ERROR`: Request was unable to be processed due to a server error. Contact our support team.
- `501` — `NOT IMPLEMENTED`: Method is not implemented on that endpoint.

---

[API](https://skmtc.net/nectarhr/apis/nectar-public-api.md) · [All operations](https://skmtc.net/nectarhr/apis/nectar-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nectarhr/nectar-public-api/revisions/c0dcbcafc495/schema)