---
canonical_url: "https://docs.composio.dev/toolkits/onlyoffice_docspace"
markdown_url: "https://docs.composio.dev/toolkits/onlyoffice_docspace.md"
product: "platform"
version: null
last_updated: null
---

# ONLYOFFICE DocSpace

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

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

## Tools

### Create Folder

**Slug:** `ONLYOFFICE_DOCSPACE_CREATE_FOLDER`

Create a named subfolder inside an existing DocSpace folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Name for the new folder. |
| `parent_folder_id` | integer | Yes | Numeric ID of the parent folder. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Text File

**Slug:** `ONLYOFFICE_DOCSPACE_CREATE_TEXT_FILE`

Create a plain-text file with supplied content inside a DocSpace folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | File title; use a .txt suffix when a specific extension is desired. |
| `content` | string | No | Plain-text content for the new file. |
| `folder_id` | integer | Yes | Numeric ID of the destination folder. |
| `create_new_if_exists` | boolean | No | Create a distinct file when a file with the same title already exists. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | Yes | Numeric ID of the file or folder to delete. |
| `item_type` | string ("file" | "folder") | Yes | Kind of item to delete. |
| `permanently` | boolean | No | If true, delete immediately instead of moving the item to Trash. Use true only for intentional teardown. |
| `delete_after_editing` | boolean | No | Delay deletion until an active editing session finishes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get File

**Slug:** `ONLYOFFICE_DOCSPACE_GET_FILE`

Return metadata, version information, and effective security flags for one file by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | Numeric ID of the file to retrieve. |
| `version` | integer | No | Optional specific file version to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Room

**Slug:** `ONLYOFFICE_DOCSPACE_GET_ROOM`

Return detailed metadata and effective security flags for one room by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `room_id` | integer | Yes | Numeric ID of the room to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum combined files and folders to return in this page (1-100). |
| `query` | string | No | Text used to filter folder contents. |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `extension` | string | No | Optional file extension filter such as .txt. |
| `folder_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List People

**Slug:** `ONLYOFFICE_DOCSPACE_LIST_PEOPLE`

List visible DocSpace users, optionally filtering by text, group membership, or administrator status.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum rooms to return in this page (1-100). |
| `query` | string | No | Text used to filter visible rooms. |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |