Manage ONLYOFFICE DocSpace files, folders, rooms and users.
Explore 30 workflow actions for ONLYOFFICE DocSpace, including account permissions and operation limits.
14 read actions16 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Archive room
Write
Moves a room with the ID specified in the request to the "Archive" section.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Check authentication
Read
Checks if the current user is authenticated or not.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
Copy file
Write
Copies (and converts if possible) an existing file to the specified folder.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Copy files and folders
Write
Copies all the selected files and folders to the folder with the ID specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create file
Write
Creates a new file in the specified folder with the title specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create folder
Write
Creates a new folder with the title specified in the request. The parent folder ID can be also specified.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create room
Write
Creates a room in the "Rooms" section.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete file
Write
Deletes a file with the ID specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete files and folders
Write
Deletes the files and folders with the IDs specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete folder
Write
Deletes a folder with the ID specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete user
Write
Deletes a user with the ID specified in the request from the portal.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Enable or disable users
Write
Changes a status of the users with the IDs specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get file information
Read
Returns the detailed information about a file with the ID specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
Get folder contents
Read
Returns the detailed list of files and folders located in the folder with the ID specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
Get folder history
Read
Returns the activity history of a folder with a specified identifier.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
Get folder information
Read
Returns the detailed information about a folder with the ID specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
Get folder path
Read
Returns a path to the folder with the ID specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
Get my profile
Read
Returns the detailed information about the current user profile.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
Get room access rights
Read
Returns the access rights of a room with the ID specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
Get room information
Read
Returns the room information.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
Get user
Read
Returns the detailed information about a profile of the user with the ID specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
Get user by email
Read
Returns the detailed information about a profile of the user with the email specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
List users
Read
Returns a list of profiles for all the portal users.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
Move files and folders
Write
Moves or copies all the selected files and folders to the folder with the ID specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Rename folder
Write
Renames the selected folder with a new title specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Search rooms
Read
Returns the contents of the "Rooms" section by the parameters specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
Search users
Read
Returns a list of users matching the search query. This method uses the query parameters.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
Update file
Write
Updates the information of the selected file with the parameters specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update room
Write
Updates a room with the ID specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update user
Write
Updates the data for the selected portal user with the first name, last name, email address, and/or optional parameters specified in the request.
Permissions and limits
Account permissions
A DocSpace API key (Developer Tools, API keys) with the needed permissions
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in ONLYOFFICE DocSpace. A saved workflow is not a completed provider action.