---
title: "Get user notifications with pagination, filtering, and field selection"
method: GET
path: "/api/v1/notifications/"
tags: ["notifications"]
---

# Get user notifications with pagination, filtering, and field selection

`GET /api/v1/notifications/`

## Request

- Base URL: `http://localhost:3000`
- URL: `http://localhost:3000/api/v1/notifications/`
- Auth: HTTP bearer

Get user notifications with pagination, filtering, and field selection

## Query parameters

- `limit` number
- `offset` number
- `unreadOnly` boolean
- `type` string
- `fields` string
- `sort` string

## Response `200`

Default Response

- object
  - `success` true, required
  - `data` object, required
    - `notifications` object[], required
      - `id` string, required: Notification ID
      - `userId` string, required: User Discord ID
      - `type` string, required: Notification type
      - `title` string, required: Notification title
      - `message` string, required: Notification message
      - `data` object: Additional data payload
      - `read` boolean, required: Read status
      - `readAt` string, date-time: Read timestamp
      - `channel` string: Delivery channel
      - `sentToDiscord` boolean: Discord delivery status
      - `discordMessageId` string: Discord message ID
      - `discordError` string: Discord delivery error
      - `createdAt` string, date-time, required: Creation timestamp
      - `_links` object: HATEOAS links
  - `meta` object, required
    - `timestamp` number, required
    - `pagination` object, required
      - `total` number, required
      - `limit` number, required
      - `offset` number, required
      - `hasMore` boolean, required
  - `_links` object: HATEOAS pagination links
    - `self` object
      - `href` string, required
      - `rel` string, required
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'
      - `type` string
    - `first` object
      - `href` string, required
      - `rel` string, required
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'
      - `type` string
    - `prev` object
      - `href` string, required
      - `rel` string, required
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'
      - `type` string
    - `next` object
      - `href` string, required
      - `rel` string, required
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'
      - `type` string
    - `last` object
      - `href` string, required
      - `rel` string, required
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'
      - `type` string

## Other responses

- `400`: Default Response
- `401`: Default Response
- `403`: Default Response
- `500`: Default Response

---

[API](https://skmtc.dev/farmersonly/apis/farmersonly-club-api.md) - [All operations](https://skmtc.dev/farmersonly/apis/farmersonly-club-api/llms.txt) - [OpenAPI document](https://skmtc.dev/farmersonly/apis/farmersonly-club-api/revisions/b4fa9123ba90?raw)
