Ideals

Delete groups. Delete groups in bulk from the specified project **Required scope (integrations):** `users.write`

delete_groups

Delete participants. Bulk-deletes one or more participants (users) from a project. Destructive – participants lose their access. Resolve users IDs/emails (via `get_users`) and ask a confirmation from a user to execute this.

delete_users

Download a file from a project. Returns the file content as base64 (max 50 MB). For larger files, use the Ideals web interface / Public API. To download a file using the Ideals UI, resolve a link to the file first using the `get_link_templates` tool. To read or analyze what a file says, use `read_file_content` instead — only call this tool when the user explicitly asks to download the file or needs the raw bytes.

download_file

Export activity log. Export the project activity log (the audit trail of who did what, and when) as an Excel file. Supports the same filters as `get_activity_logs`.

export_activity_logs

Export document index. **To summarise a project, describe it, or give an overview of what it contains, call this directly** — it is the single call that answers project-level content questions. You do **not** need Get project details first. It exports the project's full document index — every file and folder with names, sizes, upload dates, labels, direct links, and the complete folder tree, for all items the authenticated user can access — in one call. Use it to answer: - **Summarise / overview of a project** — what files and folders it holds and how it's organised. - **How big is the project / how many GB** — sum the per-item sizes. - **How many files or folders** — count the rows. - **What is the folder structure / the whole tree** — every folder and file in one call. - **Spot gaps or empty folders** — folders with no files beneath them. Use this — not Get project details, which returns only metadata (title, status, dates) with no contents, counts, or sizes.

export_document_index

Get Q&A settings. Returns the Q&A workflow configuration: step toggles, assigned users, categories, and question teams. Use to understand the Q&A setup before raising/answering questions or perform other operations with Q&A. Returns `404 Not Found` with error code `3009` if the Q&A module is not enabled for this project.

get_qna_configuration

Internal helper for the Terms of Use widget. Fetches the agreement's HTML body. Never call this directly — use get_terms_of_use instead, which returns everything needed to display and accept the terms.

get_terms_of_use_content

Display a project's Terms of Use for the user to review and Accept. Call this when the user wants to review or accept a project's Terms of Use, or after another tool reports that acceptance is required. Renders the terms with an Accept button that records the user's acceptance. This tool only DISPLAYS the terms (read-only); the user accepts by clicking the button in the card, so it is safe to call without asking the user for permission first.

get_terms_of_use

Get activity log. Get a detailed report of all actions (most recent first) performed in the project. Call this directly for any "who viewed / accessed / downloaded", "what happened", or "recent activity" question.

get_activity_logs

Get activity log action types. Returns a **static catalog of action-type identifiers**, grouped by category — reference data only. It contains **no events** and does not tell you what happened in a project or who did anything. **Rarely changed**: `get_activity_logs` and `export_activity_logs` answer activity questions on their own. Use this only to map a specific action name to its exact identifier when you need to restrict one of those endpoints to a particular action type via the `actionTypes` filter. **Required scope (integrations):** `reports.read`

get_report_actions

Get current user. Returns the identity and profile of the authenticated user, including name, email, company and job title. Use to confirm who you are acting as, or to resolve 'me'/'my' in other requests, e.g. "use my email" or "use my company".

get_current_user

Get document permissions across groups. Returns the permissions assigned to each group for a specific file or folder. Each item in the response represents one group and its access level (`None`, `FenceView`, `View`, `SaveEncrypted`, `SavePdf`, `SaveOriginal`, `Upload`, or `Manage`). **Required scope (integrations):** `documents.read`

get_permissions_by_document

Get documents from recycle bin. Returns all files and folders currently in the recycle bin for the specified project **Required scope (integrations):** `documents.read`

get_recycle_bin_documents

Get the text content of a file in a project (max 50 MB of text). Returns the text as `fileContent`. Prefer this tool over `download_file` to read or analyze what a file says. Use `download_file` only when the user needs the original file or its raw bytes. If the error says `DocumentHasNotConvertedYet`, the text of the file is not ready yet. Do not retry the call; tell the user to try again later.

read_file_content

Get folder permissions for a group. Returns the permission level assigned to a specific **group** for a specific **folder**, along with the permissions of all child items (sub-folders and files) within it. The `permissions` field reflects the effective access level: `None`, `FenceView`, `View`, `SaveEncrypted`, `SavePdf`, `SaveOriginal`, `Upload`, or `Manage`. **Required scope (integrations):** `documents.read`

get_permissions_by_folder_and_group

Get group details. Get all details such as role, feature permissions, and security settings of the given group. **Required scope (integrations):** `users.read`

get_group_details

Get link templates. Returns every web-UI deep-link template as a `type` → `urlTemplate` map. Substitute the `{placeholder}`s from other tool responses: - `{accountId}` — `get_corporate_accounts.id` - `{hostNumber}`, `{projectUniqueName}` — `get_projects` (`hostNumber`, `uniqueName`) - `{folderId}` — `get_folder_documents` folder `id` - `{fileUiId}` — `get_folder_documents` file `uiId` (numeric, not UUID), zero-padded to 9 digits (e.g. `16953551` → `016953551`) - `{projectHostUrl}` — `get_corporate_accounts.allowedHosts[i].url` where `id == hostNumber` Templates are stable per environment — cache and reuse. **Required scope (integrations):** `profile`

get_link_templates

Get list of corporate accounts. Returns corporate accounts that the authenticated user has administrative access to **Required scope (integrations):** `accounts.read`

get_corporate_accounts

Get list of folder documents. Returns all direct children (files and folders) of the specified folder. No pagination. Useful when you only need the full list of direct children without traversing subfolders (top root-level folders by default). To get every file and folder across the entire project in one call, use `export_document_index` instead.

get_folder_documents

Get list of groups. Get a list of user groups that are present in the specified project. **Required scope (integrations):** `users.read`

get_groups

Get list of label groups. Returns all label groups and their labels defined for the specified project. Use to understand the tagging scheme or to report which labels exist. **Required scope (integrations):** `documents.read`

get_label_groups

Get list of participants. Lists all participants in a project with their group. Use to resolve user IDs/emails/name before updates, deletions, and to get an overview of the access structure.

get_users

Get list of project attributes. Get a list of project attributes defined for the given corporate account. Does not contain real values of the attributes assigned to the projects. **Required scope (integrations):** `accounts.read`

get_attributes

Get list of projects. Returns the projects available to the current user through this integration, each with its **id** (UUID), name, and status. This is the entry point for any project task: resolve a project **name** to the **id** other endpoints require by matching on the name and reusing the returned id — look the id up here rather than asking for it. If an expected project is missing, the integration most likely is not enabled for it or current user does not have access to it.

get_projects

Get list of threads. Lists Q&A threads (questions) with pagination and sorting (default: most recently updated). Use for a quick overview of outstanding questions. For filtered queries (status, priority, category, keyword, dates) use `search_qna_threads`.

get_qna_threads

Get permissions report. Export a full permissions report for the project as an Excel file. The report contains a matrix of all groups and their access levels across every folder and document in the project — useful for compliance audits and access reviews. **Required scope (integrations):** `documents.read`

get_permissions_report

Get project details. Returns **only** a project's own metadata (e.g. project's root folder ID), not its contents. Do **not** call this to summarise, describe, or give an overview of a project, or to get its size, counts, or folder structure — it exposes none of those. For any of those, use `export_document_index` instead.

get_project_details_by_id

Get user details. Returns a participant's full details – name, group, and project access. REQUIRED first step before Update user settings (full replacement). Also useful for access reviews.

get_user_details

Invite participants. Adds new users to a project and assigns them to a group; always include securitySettings.accessFrom with the current date. The new user inherits the group's document permissions. All security settings are ignored if project is archived.

add_users_to_project

Move documents. Move one or more files and/or folders to a different folder within the same project. The originals no longer exist at their previous location. > [!NOTE] > Items are processed sequentially. If an item fails (for example, due to insufficient permissions), processing stops and the response contains only the items that succeeded before the failure. **Required scope (integrations):** `documents.write`

move_documents

Move documents to recycle bin. Move one or more files and/or folders to the recycle bin. Items can be restored later using the restore endpoint. **Required scope (integrations):** `documents.write`

delete_documents

Partially update file metadata. Update only specific properties of the specified file **Required scope (integrations):** `documents.write`

rename_file

Partially update folder metadata. Update only specific properties of a given folder. Rename silently returns the old name if the target name already exists — verify the response. **Required scope (integrations):** `documents.write`

rename_folder

Partially update group settings. Update only specific properties of a given group **Required scope (integrations):** `users.write`

patch_group

Permanently delete documents from recycle bin. Delete single or multiple files and/or folders from recycle bin. > [!NOTE] > This action is irreversible. Once the documents are deleted from the recycle bin, they cannot be restored. **Required scope (integrations):** `documents.write`

delete_documents_from_recycle_bin

Rename documents. Renames 2 or more files and/or folders in a project in a single call. For a single file use `rename_file`; for a single folder use `rename_folder`. Input: - id: identifier of the existing file or folder to rename - isFolder: true if the item is a folder, false if it is a file - index: current index of the item within its parent folder (e.g. "1.2.3") - newName: the desired new name Response: Returns a summary with the total count of successfully renamed and failed items, plus per-item details indicating success or failure reason for each entry. Notes: - Between 2 and 3000 items must be specified; requests outside that range are rejected. - An item with an invalid name is reported as a failed item rather than failing the whole request; other valid items are still renamed.

rename_documents

Restore documents from recycle bin. Restore single or multiple files and/or folders from recycle bin. **Required scope (integrations):** `documents.write`

restore_documents_from_recycle_bin

Search documents. Recursive search for documents under a folder (defaults to root) by query and/or filters. With an empty/`*` query and no filter, returns only the direct children of the folder. Use to find files by name or content across the whole project folder tree, or as the lookup step before summarising or answering. For a complete structural inventory (sizes, full tree, gaps) use `export_document_index` instead.

search_documents

Search threads. Search Q&A threads with advanced filtering, sorting, and pagination. Supports filtering by status, priority, category, thread type, author, assigned expert, keyword search, and date ranges. Default page size is 30. Default sorting: `UpdatedAt` descending (most recently updated first). **Sorting behavior:** - When `searchQuery` is provided and `sortBy` is not specified, results are sorted by relevance. - When `searchQuery` is not provided, results are sorted by `UpdatedAt` descending by default. - An explicit `sortBy` value always takes precedence regardless of `searchQuery`. **Category filter:** If the `category` filter is not specified, all threads are returned regardless of their category. When specified, use the `filter` field to control behavior: - `Uncategorized` — returns only threads without a category assigned. - `Categorized` — returns only threads that have any category assigned. - `Specific` — returns threads belonging to the categories listed in `ids`. **Usage examples:** Keyword search (sorted by relevance automatically): `{ "searchQuery": "due diligence deadline" }` Keyword search with explicit sorting override: `{ "searchQuery": "deadline", "sortBy": "CreatedAt", "sortOrder": "Asc" }` Filter by category: `{ "category": { "filter": "Specific", "ids": ["<guid1>", "<guid2>"] } }` Filter uncategorized threads: `{ "category": { "filter": "Uncategorized" } }` Returns `404 Not Found` with error code `3009` if the Q&A module is not enabled for this project.

search_qna_threads

Update group settings. Full replacement — all fields must be provided. Omitted fields are reset to their defaults. Always fetch the current group via GetGroupDetails first, then send all fields back with your changes applied. **Required scope (integrations):** `users.write`

update_group