---
title: "List Notifications"
method: GET
path: "/notifications"
tags: ["notifications", "Notifications"]
---

# List Notifications

`GET /notifications`

List Notifications

## Query parameters

- `cursor` string
- `per_page` integer
- `path` string
- `include_ancestors` boolean
- `group_id` string

## Response `200`

A list of Notifications objects.

- NotificationEntity[]
  - `id` integer — Notification ID
  - `path` string — Folder path to notify on
  - `group_id` integer — ID of Group to receive notifications
  - `group_name` string — Group name, if a Group ID is set
  - `group_ids` integer[] — Group IDs when the notification requires multiple groups
  - `group_names` string[] — Group names when the notification requires multiple groups
  - `triggering_group_ids` integer[] — If set, will only notify on actions made by a member of one of the specified groups
  - `triggering_user_ids` integer[] — If set, will only notify on actions made one of the specified users
  - `trigger_by_share_recipients` boolean — Notify when actions are performed by a share recipient?
  - `notify_user_actions` boolean — If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
  - `notify_on_copy` boolean — Trigger on files copied to this path?
  - `notify_on_delete` boolean — Trigger on files deleted in this path?
  - `notify_on_download` boolean — Trigger on files downloaded in this path?
  - `notify_on_move` boolean — Trigger on files moved to this path?
  - `notify_on_upload` boolean — Trigger on files created/uploaded/updated/changed in this path?
  - `recursive` boolean — Apply notification recursively? This will enable notifications for each subfolder.
  - `send_interval` 'five_minutes' | 'fifteen_minutes' | 'hourly' | 'daily' — The time interval that notifications are aggregated to
  - `subject` string — Custom subject line to use for notification emails
  - `message` string — Custom message to include in notification emails
  - `triggering_filenames` string[] — Array of filenames (possibly with wildcards) to scope trigger
  - `workspace_id` integer — Workspace ID. `0` means the default workspace.
  - `unsubscribed` boolean — Is the user unsubscribed from this notification?
  - `unsubscribed_reason` 'none' | 'unsubscribe_link_clicked' | 'mail_bounced' | 'mail_marked_as_spam' — The reason that the user unsubscribed
  - `user_id` integer — Notification user ID
  - `username` string — Notification username
  - `suppressed_email` boolean — If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `405` — Method Not Allowed
- `409` — Conflict
- `412` — Precondition Failed
- `422` — Unprocessable Entity
- `423` — Locked
- `429` — Too Many Requests

---

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