latestOpenAPI 3.0.02026-07-135965404.0 KB

a1bd874b5960

Notifications

Get a list of notifications

Get a list of all the notifications you have access to. You can use sorting and filtering to limit the returned list.

Notes:

  • Authenticated user should have notifications permission
get/notifications

Query parameters

type'file' | 'folder' | 'shared_folder' | 'send_receipt' | 'share_receipt' | 'file_drop'

Type of notification include in the list. Valid options are file, folder, send_receipt, share_receipt, file_drop

If this parameter is not used, only file and folder type notifications are included in the list.

offsetinteger

Starting notification record in the result set. Can be used for pagination.

sortstring

What order the list of matches should be in. Valid sort fields are resourcename, date, action and type. The sort order for each sort field is ascending unless it is prefixed with a minus (“-“), in which case it will be descending.

You can chose multiple options for the sort by separating them with commmas, such as "type,-date" to sort by type, then most recent.

limitinteger

Number of notification records to return. Can be used for pagination.

include'resource' | 'share' | 'user'

Related records to include in the response. Valid options are ownerUser, resource, share

action'connect' | 'download' | 'upload' | 'delete' | 'all'
Example:all

The kind of action which triggers the notification. Valid choices are connect (only for delivery receipts), download, upload, delete, or all

Note The all action matches notifications set to "all", not all notifications. For example, notifications set to trigger only on delete are not included if you filter for action=all

Headers

ev-api-keystring required

API Key required to make the API call.

ev-access-tokenstring required

Access token required to make the API call.

Response

Successful Operation

NotificationCollectionResponse required— unresolved $ref