HTTP API

Reference

Files API

Endpoints for Drive files and folders, shared drives and sharing, plus the caller's alerts, Inbox and notifications.

This group covers Drive files and folders, their versions and sharing, and shared drives. The group also carries the caller's alerts, Inbox items and notifications. Every call acts as a person: send a personal access token, or an OAuth access token from a person's sign-in (scope Volobox). An integration app's own client secret is refused with 403 (Volobox:Integrations:MemberConnectionRequired). Paths, tokens and conventions are in API overview.

Alerts

GET/api/v1/alerts
Lists the alerts the caller is a recipient of, filtered and paged.
files.alerts.getList
GET/api/v1/alerts/{id}
Gets an alert the caller is a recipient of.
files.alerts.get
POST/api/v1/alerts/{id}/acknowledge
Acknowledges an active alert for everyone it reaches.
files.alerts.acknowledge
POST/api/v1/alerts/{id}/snooze
Snoozes an alert for the caller until a given time.
files.alerts.snooze
POST/api/v1/alerts/{id}/unsnooze
Ends the caller's snooze of an alert.
files.alerts.unsnooze
POST/api/v1/alerts/seen
Marks alerts as seen by the caller.
files.alerts.markSeen

Files and folders

GET/api/v1/file-entry
Lists files and folders in a Drive view (My Drive, a shared drive, shared with me, recent, starred or trash) or in one folder, paged.
files.fileEntry.getList
GET/api/v1/file-entry/{id}
Gets a file or folder the caller can open.
files.fileEntry.get
DELETE/api/v1/file-entry/{id}
Permanently deletes a file or folder that is in Trash.
files.fileEntry.deletePermanently
GET/api/v1/file-entry/{id}/breadcrumb
Gets the path of folders from the drive root down to a file or folder.
files.fileEntry.getBreadcrumb
POST/api/v1/file-entry/{id}/copy
Copies a file to another folder or drive. A folder cannot be copied: move it instead.
files.fileEntry.copy
GET/api/v1/file-entry/{id}/download-url
Gets a short-lived URL that downloads a file, or one of its versions.
files.fileEntry.getDownloadUrl
POST/api/v1/file-entry/{id}/duplicate
Makes a copy of a file beside it under a new name. A folder cannot be duplicated.
files.fileEntry.duplicate
GET/api/v1/file-entry/{id}/location
Gets which drive and folder a file or folder is in.
files.fileEntry.getLocation
PUT/api/v1/file-entry/{id}/move
Moves a file or folder to another folder or drive.
files.fileEntry.move
GET/api/v1/file-entry/{id}/preview-url
Gets a short-lived URL that shows a file, or one of its versions, inline in a browser.
files.fileEntry.getPreviewUrl
PUT/api/v1/file-entry/{id}/rename
Renames a file or folder.
files.fileEntry.rename
POST/api/v1/file-entry/{id}/restore
Restores a file or folder from Trash.
files.fileEntry.restore
PUT/api/v1/file-entry/{id}/star
Stars or unstars a file or folder for the caller.
files.fileEntry.star
POST/api/v1/file-entry/{id}/trash
Moves a file or folder to Trash.
files.fileEntry.trash
GET/api/v1/file-entry/{id}/versions
Lists the stored versions of a file, newest first.
files.fileEntry.getVersions
POST/api/v1/file-entry/{id}/versions/restore
Makes an earlier version of a file its current version.
files.fileEntry.restoreVersion
POST/api/v1/file-entry/folder
Creates a folder in My Drive or a shared drive, at the root or under a parent folder.
files.fileEntry.createFolder
GET/api/v1/file-entry/folder-tree
Gets the folder tree of the caller's My Drive or of a shared drive.
files.fileEntry.getFolderTree

Request bodies:

  • CreateFolderDto (createFolder): requires name (string).

File sharing

GET/api/v1/file-entry/{fileEntryId}/share/members
Lists the people, groups and agents a file or folder is shared with, and their roles.
files.fileEntry.share.getMembers
POST/api/v1/file-entry/{fileEntryId}/share/members
Shares a file or folder with a person, group or agent, or changes the role of one it is already shared with.
files.fileEntry.share.addOrUpdateMember
DELETE/api/v1/file-entry/{fileEntryId}/share/members/{memberId}
Stops sharing a file or folder with a person, group or agent.
files.fileEntry.share.removeMember

Inbox

GET/api/v1/inbox
Lists the items waiting in the caller's Inbox, such as approvals and questions, filtered and paged.
files.inbox.getList
POST/api/v1/inbox/{id}/dismiss
Dismisses an item from the caller's Inbox.
files.inbox.dismiss

Shared drives

GET/api/v1/shared-drive
Lists the shared drives the caller can open.
files.sharedDrive.getList
POST/api/v1/shared-drive
Creates a shared drive with the caller as its admin.
files.sharedDrive.create
GET/api/v1/shared-drive/{id}
Gets a shared drive the caller can open.
files.sharedDrive.get
PUT/api/v1/shared-drive/{id}
Updates a shared drive the caller administers.
files.sharedDrive.update
DELETE/api/v1/shared-drive/{id}
Deletes a shared drive the caller administers.
files.sharedDrive.delete
GET/api/v1/shared-drive/{id}/members
Lists the people, groups and agents that are members of a shared drive, and their roles.
files.sharedDrive.getMembers
POST/api/v1/shared-drive/{id}/members
Adds a person, group or agent to a shared drive, or changes the role of an existing member.
files.sharedDrive.addOrUpdateMember
DELETE/api/v1/shared-drive/{id}/members/{memberId}
Removes a member from a shared drive.
files.sharedDrive.removeMember
PUT/api/v1/shared-drive/{id}/star
Stars or unstars a shared drive for the caller.
files.sharedDrive.star
GET/api/v1/shared-drive/for-user/{userId}
Lists the shared drives a workspace member belongs to that the caller can also open.
files.sharedDrive.getForUser

Request bodies:

  • CreateSharedDriveDto (create): requires name (string).
  • UpdateSharedDriveDto (update): requires name (string).

Notifications

GET/api/v1/user-notification
Lists the caller's notifications, newest first, filtered and paged.
files.userNotification.getList
POST/api/v1/user-notification/{id}/mark-read
Marks one of the caller's notifications as read.
files.userNotification.markRead
POST/api/v1/user-notification/mark-all-read
Marks all of the caller's notifications as read.
files.userNotification.markAllRead

Example

files.fileEntry.getList: lists files and folders in a Drive view (My Drive, a shared drive, shared with me, recent, starred or trash) or in one folder, paged.

curl
curl -s "https://volobox.example.com/api/v1/file-entry?SkipCount=0&MaxResultCount=20" \
  -H "Authorization: Bearer $VOLOBOX_TOKEN"

SkipCount is how many items to skip and MaxResultCount how many to return. The answer carries totalCount and the page of items.