---
title: "Get notification preferences"
method: GET
path: "/api/v1/notifications/preferences"
tags: ["notifications"]
---

# Get notification preferences

`GET /api/v1/notifications/preferences`

## Request

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

Get notification preferences

## Response `200`

Default Response

- object
  - `success` true, required
  - `data` object, required
    - `loanUpdates` object: Loan update notification channel preferences
      - `web` boolean
      - `discord` boolean
      - `push` boolean
    - `invoiceUpdates` object: Invoice update notification channel preferences
      - `web` boolean
      - `discord` boolean
      - `push` boolean
    - `paymentUpdates` object: Payment update notification channel preferences
      - `web` boolean
      - `discord` boolean
      - `push` boolean
    - `systemMessages` object: System message notification channel preferences
      - `web` boolean
      - `discord` boolean
      - `push` boolean
    - `realtyUpdates` object: Realty update notification channel preferences
      - `web` boolean
      - `discord` boolean
      - `push` boolean
    - `enableWebNotifications` boolean: Web notifications enabled
    - `enableDiscordNotifications` boolean: Discord notifications enabled
  - `meta` object, required
    - `timestamp` number, required

## 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)
