---
title: "Get Notification Request List"
method: GET
path: "/notifications/requests"
tags: ["Notification Requests"]
---

# Get Notification Request List

`GET /notifications/requests`

Get the list of a notification request

## Query parameters

- `page` integer — Page number
- `query` string — Filter query JSON string
- `size` integer — Page size
- `sort` string — Sort option JSON string

## Response `200`

OK

- ControllersListResponseGithubModelsNotificationRequestDTO
  - `data` ModelsNotificationRequestDTO[]
    - `NotificationRequest` ModelsNotificationRequest — The data to update
      - `_id` string, objectid — ID
      - `channel` ModelsNotificationChannel — The data to update
        - `_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
      - `channel_id` string, objectid — Channel ID
      - `content` string — Content
      - `created_at` string, date-time — Created timestamp
      - `created_by` string, objectid — Created by
      - `error` string — Error
      - `mail_bcc` string[] — Mail BCC
      - `mail_cc` string[] — Mail CC
      - `mail_to` string[] — Mail to
      - `sender_email` string — Sender email
      - `sender_name` string — Sender name
      - `setting` 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
      - `setting_id` string, objectid — Setting ID
      - `status` string — Status
      - `test` boolean — Test
      - `title` string — Title
      - `updated_at` string, date-time — Updated timestamp
      - `updated_by` string, objectid — Updated by
    - `channel` ModelsNotificationChannel — The data to update
      - `_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
    - `setting` 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
  - `error` string
  - `message` string
  - `status` string
  - `total` integer

## Other responses

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

---

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