v4

latestSwagger 2.02026-08-0343714211.7 MB

bundle_notifications

Bundle Notifications

List Share Link Notifications

get/bundle_notifications

Query parameters

user_idinteger

User ID. Provide a value of 0 to operate the current session's user.

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 and bundle_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are bundle_id.

bundle_idinteger

Bundle ID

Response

A list of BundleNotifications objects.

bundle_idinteger

Bundle ID to notify on

idinteger

Bundle Notification ID

notify_on_registrationboolean

Triggers bundle notification when a registration action occurs for it.

notify_on_uploadboolean

Triggers bundle notification when a upload action occurs for it.

notify_current_userboolean

Is the current user the user to notify?

notify_user_idinteger

The id of the user to notify.

workspace_idinteger

Workspace ID. 0 means the default workspace.

Example response

[
  {
    "bundle_id": 1,
    "id": 1,
    "notify_on_registration": true,
    "notify_on_upload": true,
    "notify_current_user": true,
    "notify_user_id": 1,
    "workspace_id": 1
  }
]