---
title: "GET /api/perks"
method: GET
path: "/api/perks"
tags: ["api", "perks"]
---

# GET /api/perks

`GET /api/perks`

List all Perks

## Query parameters

- `top` integer, required — A limit on the number of objects to be returned. Can range between 1 and 1000.
- `skip` integer, required — The number of objects to skip for the requested result
- `name` string — Filter by perk name

## Response `200`

OK

- object
  - `docs` PerkResource[], required
    - `_id` string, required — The ID of the perk
    - `name` string, required — The name of the perk
    - `description` string — A description of the perk
    - `images` string[] — URLs of perk images
    - `sellerId` string, required — The ID of the seller owning this perk
    - `createdAt` string, date-time, required — When the perk was created
    - `updatedAt` string, date-time, required — When the perk was last updated
  - `total` number, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

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