Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
notifications
Notifications

List Notifications

List Notifications

get/notifications

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id, path, user_id or group_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are path, user_id, workspace_id or group_id. Valid field combinations are [ workspace_id, path ], [ workspace_id, user_id ], [ workspace_id, group_id ] or [ workspace_id, user_id, path ].

If set, return records where the specified field is prefixed by the supplied value. Valid fields are path.

pathstring

Show notifications for this Path.

include_ancestorsboolean

If include_ancestors is true and path is specified, include notifications for any parent paths. Ignored if path is not specified.

group_idstring

Response

A list of Notifications objects.

idinteger

Notification ID

pathstring

Folder path to notify on

group_idinteger

ID of Group to receive notifications

group_namestring

Group name, if a Group ID is set

group_idsinteger[]

Group IDs when the notification requires multiple groups

group_namesstring[]

Group names when the notification requires multiple groups

triggering_group_idsinteger[]

If set, will only notify on actions made by a member of one of the specified groups

triggering_user_idsinteger[]

If set, will only notify on actions made one of the specified users

trigger_by_share_recipientsboolean

Notify when actions are performed by a share recipient?

notify_user_actionsboolean

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_copyboolean

Trigger on files copied to this path?

notify_on_deleteboolean

Trigger on files deleted in this path?

notify_on_downloadboolean

Trigger on files downloaded in this path?

notify_on_moveboolean

Trigger on files moved to this path?

notify_on_uploadboolean

Trigger on files created/uploaded/updated/changed in this path?

recursiveboolean

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

subjectstring

Custom subject line to use for notification emails

messagestring

Custom message to include in notification emails

triggering_filenamesstring[]

Array of filenames (possibly with wildcards) to scope trigger

workspace_idinteger

Workspace ID. 0 means the default workspace.

unsubscribedboolean

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_idinteger

Notification user ID

usernamestring

Notification username

suppressed_emailboolean

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.

Example response

[
  {
    "id": 1,
    "path": "path",
    "group_name": "example",
    "group_ids": [
      1
    ],
    "group_names": [
      "example"
    ],
    "triggering_group_ids": [
      1
    ],
    "triggering_user_ids": [
      1
    ],
    "trigger_by_share_recipients": true,
    "notify_user_actions": true,
    "notify_on_copy": true,
    "notify_on_delete": true,
    "notify_on_download": true,
    "notify_on_move": true,
    "notify_on_upload": true,
    "recursive": true,
    "send_interval": "fifteen_minutes",
    "subject": "Vendor A CSV Activity",
    "message": "custom notification email message",
    "triggering_filenames": [
      "*.jpg",
      "notify_file.txt"
    ],
    "workspace_id": 1,
    "unsubscribed": true,
    "unsubscribed_reason": "example",
    "user_id": 1,
    "username": "User",
    "suppressed_email": true
  }
]