> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ONLYOFFICE DocSpace

> ONLYOFFICE DocSpace provides tenant-hosted APIs for managing rooms, documents, files, folders, users, groups, sharing, and portal settings.

![ONLYOFFICE DocSpace logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/onlyoffice_docspace.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=e0fce8104954b933a1ba4ffb9c8cfdc7)

* **Category:** documents
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 10
* **Triggers:** 0
* **Slug:** `ONLYOFFICE_DOCSPACE`
* **Version:** 00000000\_00

## Tools

> [accordion] Create Folder
>
> **Slug:** `ONLYOFFICE_DOCSPACE_CREATE_FOLDER`
>
> Create a named subfolder inside an existing DocSpace folder.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> Name for the new folder.
>
> **parent\_folder\_id** `integer` *required*
>
> Numeric ID of the parent folder.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Text File
>
> **Slug:** `ONLYOFFICE_DOCSPACE_CREATE_TEXT_FILE`
>
> Create a plain-text file with supplied content inside a DocSpace folder.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> File title; use a .txt suffix when a specific extension is desired.
>
> **content** `string`
>
> Plain-text content for the new file.
>
> **folder\_id** `integer` *required*
>
> Numeric ID of the destination folder.
>
> **create\_new\_if\_exists** `boolean`
>
> Create a distinct file when a file with the same title already exists.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete File Or Folder
>
> **Slug:** `ONLYOFFICE_DOCSPACE_DELETE_ITEM`
>
> Move one file or folder to Trash, or permanently delete it when explicitly requested, then wait for the asynchronous operation to finish.
>
> #### Input Parameters
>
> **item\_id** `integer` *required*
>
> Numeric ID of the file or folder to delete.
>
> **item\_type** `string ("file" | "folder")` *required*
>
> Kind of item to delete.
>
> **permanently** `boolean`
>
> If true, delete immediately instead of moving the item to Trash. Use true only for intentional teardown.
>
> **delete\_after\_editing** `boolean`
>
> Delay deletion until an active editing session finishes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account Context
>
> **Slug:** `ONLYOFFICE_DOCSPACE_GET_ACCOUNT_CONTEXT`
>
> Return the connected user's identity, non-secret API-key metadata, available key permissions, portal capabilities, and quota features in one read-only preflight.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get File
>
> **Slug:** `ONLYOFFICE_DOCSPACE_GET_FILE`
>
> Return metadata, version information, and effective security flags for one file by ID.
>
> #### Input Parameters
>
> **file\_id** `integer` *required*
>
> Numeric ID of the file to retrieve.
>
> **version** `integer`
>
> Optional specific file version to inspect.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Room
>
> **Slug:** `ONLYOFFICE_DOCSPACE_GET_ROOM`
>
> Return detailed metadata and effective security flags for one room by ID.
>
> #### Input Parameters
>
> **room\_id** `integer` *required*
>
> Numeric ID of the room to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Folder Items
>
> **Slug:** `ONLYOFFICE_DOCSPACE_LIST_FOLDER_ITEMS`
>
> List files and subfolders in My Documents or a folder selected by numeric ID, with optional text or extension filtering.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum combined files and folders to return in this page (1-100).
>
> **query** `string`
>
> Text used to filter folder contents.
>
> **cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **extension** `string`
>
> Optional file extension filter such as .txt.
>
> **folder\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Groups
>
> **Slug:** `ONLYOFFICE_DOCSPACE_LIST_GROUPS`
>
> List or search DocSpace groups, optionally restricted to groups associated with a user or manager role.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum groups to return in this page (1-100).
>
> **query** `string`
>
> Text used to filter or search group data.
>
> **cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **manager** `boolean`
>
> When user\_id is supplied, optionally restrict results by whether that user manages the group.
>
> **user\_id** `string`
>
> Optional user UUID used to restrict groups.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List People
>
> **Slug:** `ONLYOFFICE_DOCSPACE_LIST_PEOPLE`
>
> List visible DocSpace users, optionally filtering by text, group membership, or administrator status.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum users to return in this page (1-100).
>
> **query** `string`
>
> Text used to search user records.
>
> **cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **group\_id** `string`
>
> Optional group UUID used to restrict results.
>
> **without\_group** `boolean`
>
> When true, return users who do not belong to a group.
>
> **is\_administrator** `boolean`
>
> Optionally restrict results by administrator status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Rooms
>
> **Slug:** `ONLYOFFICE_DOCSPACE_LIST_ROOMS`
>
> List rooms visible to the connected account, optionally filtering by text and continuing from a previous page.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum rooms to return in this page (1-100).
>
> **query** `string`
>
> Text used to filter visible rooms.
>
> **cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
