Skip to main content
ONLYOFFICE DocSpace logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: ONLYOFFICE_DOCSPACE
  • Version: 00000000_00

Tools

Slug: ONLYOFFICE_DOCSPACE_CREATE_FOLDERCreate a named subfolder inside an existing DocSpace folder.

Input Parameters

string
required
Name for the new folder.
integer
required
Numeric ID of the parent folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONLYOFFICE_DOCSPACE_CREATE_TEXT_FILECreate a plain-text file with supplied content inside a DocSpace folder.

Input Parameters

string
required
File title; use a .txt suffix when a specific extension is desired.
string
Plain-text content for the new file.
integer
required
Numeric ID of the destination folder.
boolean
Create a distinct file when a file with the same title already exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONLYOFFICE_DOCSPACE_DELETE_ITEMMove one file or folder to Trash, or permanently delete it when explicitly requested, then wait for the asynchronous operation to finish.

Input Parameters

integer
required
Numeric ID of the file or folder to delete.
string ("file" | "folder")
required
Kind of item to delete.
boolean
If true, delete immediately instead of moving the item to Trash. Use true only for intentional teardown.
boolean
Delay deletion until an active editing session finishes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONLYOFFICE_DOCSPACE_GET_ACCOUNT_CONTEXTReturn the connected user’s identity, non-secret API-key metadata, available key permissions, portal capabilities, and quota features in one read-only preflight.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONLYOFFICE_DOCSPACE_GET_FILEReturn metadata, version information, and effective security flags for one file by ID.

Input Parameters

integer
required
Numeric ID of the file to retrieve.
integer
Optional specific file version to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONLYOFFICE_DOCSPACE_GET_ROOMReturn detailed metadata and effective security flags for one room by ID.

Input Parameters

integer
required
Numeric ID of the room to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONLYOFFICE_DOCSPACE_LIST_FOLDER_ITEMSList files and subfolders in My Documents or a folder selected by numeric ID, with optional text or extension filtering.

Input Parameters

integer
Maximum combined files and folders to return in this page (1-100).
string
Text used to filter folder contents.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string
Optional file extension filter such as .txt.
string
Numeric ID of the folder whose contents to list. Omit this field to list My Documents and discover its folder ID in current.id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONLYOFFICE_DOCSPACE_LIST_GROUPSList or search DocSpace groups, optionally restricted to groups associated with a user or manager role.

Input Parameters

integer
Maximum groups to return in this page (1-100).
string
Text used to filter or search group data.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
boolean
When user_id is supplied, optionally restrict results by whether that user manages the group.
string
Optional user UUID used to restrict groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONLYOFFICE_DOCSPACE_LIST_PEOPLEList visible DocSpace users, optionally filtering by text, group membership, or administrator status.

Input Parameters

integer
Maximum users to return in this page (1-100).
string
Text used to search user records.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string
Optional group UUID used to restrict results.
boolean
When true, return users who do not belong to a group.
boolean
Optionally restrict results by administrator status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONLYOFFICE_DOCSPACE_LIST_ROOMSList rooms visible to the connected account, optionally filtering by text and continuing from a previous page.

Input Parameters

integer
Maximum rooms to return in this page (1-100).
string
Text used to filter visible rooms.
string
Opaque continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not