---
title: "Get Notification Setting List"
method: GET
path: "/notifications/settings"
tags: ["Notification Settings"]
---

# Get Notification Setting List

`GET /notifications/settings`

Get a list of notification settings

## Query parameters

- `filter` string — Filter query
- `page` integer — Page number
- `size` integer — Page size
- `sort` string — Sort options

## Response `200`

OK

- ControllersListResponseGithubModelsNotificationSettingDTO
  - `data` ModelsNotificationSettingDTO[]
    - `NotificationSetting` ModelsNotificationSetting — The data to update
      - `_id` string, objectid — ID
      - `channel_ids` string[] — Channel IDs
      - `created_at` string, date-time — Created timestamp
      - `created_by` string, objectid — Created by
      - `description` string — Description
      - `enabled` boolean — Enabled
      - `mail_bcc` string[] — Mail BCC
      - `mail_cc` string[] — Mail CC
      - `mail_to` string[] — Mail to
      - `name` string — Name
      - `sender_email` string — Sender email
      - `sender_name` string — Sender name
      - `task_trigger` string — Task trigger
      - `template` string — Template
      - `template_markdown` string — Template markdown
      - `template_mode` string — Template mode
      - `template_rich_text` string — Template rich text
      - `template_rich_text_json` string — Template rich text JSON
      - `template_theme` string — Template theme
      - `title` string — Title
      - `trigger` string — Trigger
      - `updated_at` string, date-time — Updated timestamp
      - `updated_by` string, objectid — Updated by
      - `use_custom_sender_email` boolean — Use custom sender email
    - `channels` ModelsNotificationChannel[]
      - `_id` string, objectid — ID
      - `created_at` string, date-time — Created timestamp
      - `created_by` string, objectid — Created by
      - `description` string — Description
      - `google_oauth2_json` string — Google OAuth2 JSON
      - `name` string — Name
      - `provider` string — Provider
      - `smtp_password` string — SMTP password
      - `smtp_port` integer — SMTP port
      - `smtp_server` string — SMTP server
      - `smtp_username` string — SMTP username
      - `telegram_bot_token` string — Telegram bot token
      - `telegram_chat_id` string — Telegram chat ID
      - `type` 'im' | 'mail' — Type
      - `updated_at` string, date-time — Updated timestamp
      - `updated_by` string, objectid — Updated by
      - `webhook_url` string — Webhook URL
  - `error` string
  - `message` string
  - `status` string
  - `total` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

## Changes

- **2026-07-17** `c7a4715c1f13` — 3 breaking, 3 warning, 11 info
  - for the `query` request parameter `page`, the type/format was changed from `integer`/`` to `integer`/`int32`
  - for the `query` request parameter `size`, the type/format was changed from `integer`/`` to `integer`/`int32`
  - the `data` response's property type/format changed from `object`/`` to `array`/`` for status `200`
  - removed the optional property `code` from the response with the `200` status
  - …13 more
- **2025-03-03** `14e4eafea538` — 4 info
  - added the new optional `query` request parameter `page`
  - added the new optional `query` request parameter `size`
  - added the optional property `data/list` to the response with the `200` status
  - added the optional property `data/total` to the response with the `200` status
- **2025-03-02** `526e5bdf6dee` — 1 breaking, 7 warning, 7 info
  - the `data` response's property type/format changed from `array`/`` to `object`/`` for status `200`
  - deleted the `query` request parameter `filter`
  - deleted the `query` request parameter `page`
  - deleted the `query` request parameter `size`
  - …11 more

[Change history](https://skmtc.dev/crawlab-team/apis/crawlab-api/changes/notifications/settings/get.md)

---

[API](https://skmtc.dev/crawlab-team/apis/crawlab-api.md) · [All operations](https://skmtc.dev/crawlab-team/apis/crawlab-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/crawlab-team/crawlab-api/revisions/c7a4715c1f13/schema)