# Outline Team knowledge base and wiki for managing documentation and collaboration - **Category:** productivity - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 101 - **Triggers:** 0 - **Slug:** `OUTLINE` - **Version:** 00000000_00 ## Tools ### Activate User **Slug:** `OUTLINE_ACTIVATE_USER` Tool to activate a previously suspended user in Outline. Activating a user allows them to sign in again and will cause billing totals to be re-calculated in the hosted version. Use when you need to restore access for a suspended user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the user. | #### 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 | ### Add Group to Collection **Slug:** `OUTLINE_ADD_COLLECTION_GROUP` Tool to add a group to a collection in Outline. Use when you need to grant all members of a group access to a specific collection with read or write permissions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Collection ID (UUID). The unique identifier of the collection to which the group will be added. | | `groupId` | string | Yes | Group ID (UUID). The unique identifier of the group to add to the collection. | | `permission` | string | No | Permission level to grant to the group. Common values are 'read' for read-only access and 'read_write' for read and write access. | #### 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 | ### Add Document User **Slug:** `OUTLINE_ADD_DOCUMENT_USER` Tool to add a user membership to a document. Use when you need to grant a user access to a specific document. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Document identifier. Either the UUID or the urlId is acceptable. | | `userId` | string | Yes | User ID of the user to add to the document | | `permission` | string | No | Permission level for the user being added to the document. If not specified, the default permission will be used. | #### 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 | ### Add Group to Document **Slug:** `OUTLINE_ADD_GROUP_TO_DOCUMENT` Tool to give all members in a group access to a document. Use when you need to grant document-level access permissions to an entire group at once, rather than adding individual users one by one. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document. Either the UUID or the urlId is acceptable. | | `groupId` | string | Yes | Unique identifier (UUID) for the group to add to the document. | | `permission` | string ("read" | "read_write") | No | Permission levels for document access. | #### 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 | ### Add User to Group **Slug:** `OUTLINE_ADD_GROUP_USER` Tool to add a user to a group. Use when you need to grant a user membership in a specific group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Identifier for the group | | `userId` | string | Yes | Identifier for the user to add to the group | #### 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 | ### Add User to Collection **Slug:** `OUTLINE_ADD_USER_TO_COLLECTION` Tool to add a user to a collection with specified permissions. Use when you need to grant a user access to a specific collection. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Identifier for the collection | | `userId` | string | Yes | Identifier for the user to add to the collection | | `permission` | string | No | Permission level for the user in the collection (e.g., 'read', 'read_write') | #### 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 | ### Archive Document **Slug:** `OUTLINE_ARCHIVE_DOCUMENT` Tool to archive a document in Outline. Use when you need to move outdated information out of sight while retaining the ability to search and restore it later. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document. Either the UUID or the urlId is acceptable. | #### 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 Attachment **Slug:** `OUTLINE_CREATE_ATTACHMENT` Tool to create an attachment in Outline. This creates a database record and returns the inputs needed to generate a signed URL and upload the file from the client to cloud storage. Use when you need to prepare an attachment for upload to associate with a document. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the file attachment | | `size` | integer | Yes | Size of the file attachment in bytes | | `documentId` | string | No | Identifier for the associated document, if any | | `contentType` | string | Yes | MIME type of the file attachment (e.g., 'application/pdf', 'image/png', 'text/plain') | #### 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 Collection **Slug:** `OUTLINE_CREATE_COLLECTION` Tool to create a new collection in Outline. Use when you need to organize documents by creating a new collection with a specific name, description, icon, color, and permission settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `icon` | string | No | A string that represents an icon in the outline-icons package or an emoji | | `name` | string | Yes | Name of the collection to create | | `color` | string | No | A hex color code for the collection icon | | `sharing` | boolean | No | Whether public sharing of documents is allowed in this collection | | `permission` | string ("read" | "read_write") | No | Permission level for collection access. | | `description` | string | No | A brief description of the collection, markdown supported | #### 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 Comment **Slug:** `OUTLINE_CREATE_COMMENT` Tool to create a comment on an Outline document. Use when you need to add a comment or reply to a document. Either text or data field is required for the comment body. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Optional comment identifier. If not provided, one will be generated automatically. | | `data` | string | No | The body of the comment as structured data. Either text or data is required. | | `text` | string | No | The body of the comment in markdown format. Either text or data is required. | | `documentId` | string | Yes | The unique identifier of the document to comment on | | `parentCommentId` | string | No | Parent comment ID for replies. Specify this to create a threaded reply to an existing comment. | #### 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 Document **Slug:** `OUTLINE_CREATE_DOCUMENT` Tool to create a new document in Outline. Use when you need to create a new document with specified title, content, and metadata. Documents can be created as drafts or immediately published to a collection. At least one of collectionId or parentDocumentId is required if publish is true. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Optional identifier for the document (UUID format) | | `icon` | string | No | Icon displayed alongside the document title (emoji or icon name) | | `text` | string | No | The body of the document in markdown format | | `color` | string | No | Color for the document icon in hex format (e.g., #FF0000) | | `title` | string | No | Document title. If not provided, a default title will be generated | | `publish` | boolean | No | Whether this document should be immediately published and made visible to other workspace members. Requires collectionId or parentDocumentId | | `createdAt` | string | No | Optionally set the created date in the past (ISO 8601 date-time format) | | `fullWidth` | boolean | No | Whether the document should be displayed in full width mode | | `templateId` | string | No | Template ID (UUID format) to use for creating the document | | `collectionId` | string | No | Identifier for the collection (UUID format). Required to publish unless parentDocumentId is provided | | `dataAttributes` | array | No | Custom data attributes to be included on the document | | `parentDocumentId` | string | No | Identifier for the parent document (UUID format). Required to publish unless collectionId is provided. Used to nest documents | #### 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 Group **Slug:** `OUTLINE_CREATE_GROUP` Tool to create a new group in Outline. Use when you need to organize users into logical groups for easier permission management across collections. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the group to create. Groups are used to organize users and assign collection permissions to multiple users at once. | #### 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 OAuth Client **Slug:** `OUTLINE_CREATE_O_AUTH_CLIENT` Tool to create a new OAuth client in Outline. Use when you need to create an OAuth client application that can be used to authenticate users and access the API on their behalf. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the OAuth client | | `avatarUrl` | string | No | A URL pointing to an image representing the OAuth client | | `published` | boolean | No | Whether the OAuth client is available to other workspaces | | `description` | string | No | A short description of this OAuth client | | `developerUrl` | string | No | The URL of the developer who created this OAuth client | | `redirectUris` | array | Yes | List of redirect URIs for the OAuth client. These URIs are used for OAuth callbacks after authentication | | `developerName` | string | No | The name of the developer who created this OAuth client | #### 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 Share **Slug:** `OUTLINE_CREATE_SHARE` Tool to create a public share link for an Outline document. Use when you need to generate a shareable URL that allows access without workspace membership. If you request multiple shares for the same document with the same API key, the same share object will be returned. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `password` | string | No | Optional password protection for the share. Users must enter this password to access the shared document | | `expiresAt` | string | No | Expiration timestamp for the share link (ISO 8601 date-time format). If not provided, the share link will not expire | | `documentId` | string | Yes | The unique identifier of the document to share (UUID format) | | `includeChildDocuments` | boolean | No | Whether child documents should be included in the share. If true, shared access includes nested documents | #### 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 Star **Slug:** `OUTLINE_CREATE_STAR` Tool to create a star for a document or collection in Outline. Use when you need to star (favorite) a document or collection so it appears in the user's sidebar. One of either documentId or collectionId must be provided. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `index` | string | No | Index of the star in the list of stars. Used to control the position of the star in the sidebar. | | `documentId` | string | No | The unique identifier (UUID) of the document to star. Either documentId or collectionId must be provided. | | `collectionId` | string | No | The unique identifier (UUID) of the collection to star. Either documentId or collectionId must be provided. | #### 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 Template **Slug:** `OUTLINE_CREATE_TEMPLATE` Tool to create a new template in Outline. Use when you need to create a reusable template that can be used as a starting point for new documents. Templates can optionally be scoped to a specific collection. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Optionally provide a specific UUID for the template | | `data` | object | Yes | The body of the template as a Prosemirror document. Must be a valid Prosemirror JSON structure with type, content, and other required fields. | | `icon` | string | No | An emoji to use as the template icon | | `color` | string | No | The color of the template icon in hex format | | `title` | string | Yes | The title of the template | | `collectionId` | string | No | Identifier for the collection to which the template belongs. Templates can optionally be scoped to a specific collection. | #### 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 View **Slug:** `OUTLINE_CREATE_VIEW` Tool to create a view for a document. Use when you need to record that a document has been viewed. Note: It is recommended that views are not created from outside of the Outline UI. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `documentId` | string | Yes | The unique identifier of the document to create a view for. This must be a valid UUID of an existing document in the workspace. | #### 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 Attachment **Slug:** `OUTLINE_DELETE_ATTACHMENT` Tool to delete an attachment from Outline. Deleting an attachment is permanent. It will not delete references or links to the attachment that may exist in your documents. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the attachment. | #### 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 Collection **Slug:** `OUTLINE_DELETE_COLLECTION` Tool to delete a collection and all of its documents from Outline. Use when you need to permanently remove a collection. This action cannot be undone, so use with caution. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier (UUID) of the collection to delete. All documents within the collection will also be permanently deleted. | #### 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 Comment **Slug:** `OUTLINE_DELETE_COMMENT` Tool to delete a comment in Outline. Use when you need to remove a comment from a document. If the comment is a top-level comment, all its children will be deleted as well. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier for the comment to delete. If the comment is a top-level comment, all its children will be deleted as well. | #### 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 Document **Slug:** `OUTLINE_DELETE_DOCUMENT` Tool to delete a document in Outline. Deleting a document moves it to the trash by default. If not restored within 30 days it is permanently deleted. Use permanent=true to destroy the document immediately with no way to recover. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document. Either the UUID or the urlId is acceptable. | | `permanent` | boolean | No | If set to true the document will be destroyed with no way to recover rather than moved to the trash. | #### 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 Operation **Slug:** `OUTLINE_DELETE_FILE_OPERATION` Tool to delete a file operation and its associated files from Outline. Use when you need to clean up completed or failed import/export operations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the file operation. | #### 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 Group **Slug:** `OUTLINE_DELETE_GROUP` Tool to delete a group from Outline. Deleting a group will cause all of its members to lose access to any collections the group has previously been added to. This action cannot be undone, so use with caution. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier (UUID) of the group to delete. Deleting a group will cause all of its members to lose access to any collections the group has previously been added to. | #### 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 OAuth Authentication **Slug:** `OUTLINE_DELETE_OAUTH_AUTHENTICATION` Tool to delete an OAuth authentication in Outline. Use when you need to revoke a third-party application's access to a user's account. This action removes the OAuth authentication connection between Outline and the third-party application. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `scope` | array | No | Optional array of permission scopes to delete. If not provided, all scopes will be deleted. | | `oauthClientId` | string | Yes | The unique identifier (UUID) of the OAuth client whose authentication should be deleted. This will revoke the third-party application's access to the user's account. | #### 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 OAuth Client **Slug:** `OUTLINE_DELETE_OAUTH_CLIENT` Tool to delete an OAuth client from Outline. Permanently delete an OAuth client and revoke all associated access tokens. This action cannot be undone, so use with caution. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the OAuth client to delete. Deleting an OAuth client will permanently revoke all associated access tokens. This action cannot be undone. | #### 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 Star **Slug:** `OUTLINE_DELETE_STAR` Tool to delete a star from a document in Outline. Use when you need to remove a star from a user's starred documents list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier (UUID) of the star to delete. Removes the star from the document, removing it from the user's starred documents list in the sidebar. | #### 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 Template **Slug:** `OUTLINE_DELETE_TEMPLATE` Tool to delete a template in Outline. This will soft-delete the template, it can be restored later. Use when you need to remove a template from the workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the template. Either the UUID or the urlId is acceptable. | #### 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 User **Slug:** `OUTLINE_DELETE_USER` Tool to delete a user in Outline. Deleting a user removes the object entirely. In almost every circumstance it is preferable to suspend a user, as a deleted user can be recreated by signing in with SSO again. Use when you need to permanently remove a user from the workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the user. | #### 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 | ### Duplicate Document **Slug:** `OUTLINE_DUPLICATE_DOCUMENT` Tool to duplicate an Outline document. Use when you need to create a copy of an existing document, optionally including all child documents in the hierarchy. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document. Either the UUID or the urlId is acceptable. | | `title` | string | No | New title for the duplicated document. If not provided, the title of the original document will be used. | | `publish` | boolean | No | Whether the new document should be published. If false or not specified, the document will maintain the same publish state as the original. | | `recursive` | boolean | No | Whether child documents should also be duplicated. Set to true to duplicate the entire document tree. | | `collectionId` | string | No | Identifier for the collection the document should be copied to. If not provided, the document will be duplicated in the same collection as the original. | | `parentDocumentId` | string | No | Identifier for the parent document the document should be copied to. If not provided, the document will be duplicated at the same level in the hierarchy. | #### 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 | ### Duplicate Template **Slug:** `OUTLINE_DUPLICATE_TEMPLATE` Tool to duplicate an Outline template. Use when you need to create a copy of an existing template, optionally with a new title or in a different collection. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the template to duplicate. Either the UUID or the urlId is acceptable. | | `title` | string | No | Override the title of the duplicated template. If not provided, the title of the original template will be used. | | `collectionId` | string | No | Identifier for the collection to place the duplicated template in. If not provided, uses the original template's collection. | #### 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 | ### Empty Documents Trash **Slug:** `OUTLINE_EMPTY_DOCUMENTS_TRASH` Tool to permanently delete all documents in the trash. Use when you need to empty the trash and remove all trashed documents permanently. WARNING: This action is irreversible and only available to admin users. #### 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 | ### Export All Collections **Slug:** `OUTLINE_EXPORT_ALL_COLLECTIONS` Tool to export all collections and their documents in bulk. Use when you need to create a backup or export of all workspace collections. Returns a FileOperation object for tracking export progress. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `format` | string ("outline-markdown" | "json" | "html") | No | Export format. Options: 'outline-markdown' (default), 'json', or 'html' | | `includePrivate` | boolean | No | Whether to include private collections in the export | | `includeAttachments` | boolean | No | Whether to include attachments in the export | #### 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 | ### Export Collection **Slug:** `OUTLINE_EXPORT_COLLECTION` Tool to export a collection in markdown, JSON, or HTML format. Triggers a bulk export that includes all documents and attachments. If documents are nested, they will be organized in folders within the zip file. Returns a fileOperation object to track progress. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier (UUID) of the collection to export. | | `format` | string ("outline-markdown" | "json" | "html") | No | Format options for collection export. | #### 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 | ### Export Document **Slug:** `OUTLINE_EXPORT_DOCUMENT` Tool to export a document from Outline in Markdown, HTML, or PDF format. The response format is determined by the Accept header (text/markdown, text/html, or application/pdf). Use when you need to download or extract document content for external processing, archiving, or sharing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document. Either the UUID or the urlId is acceptable. | | `paper_size` | string | No | Paper size for PDF export. Common values: A4, Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A5, A6. Only applicable when Accept header is application/pdf. | | `signed_urls` | integer | No | How long signed URLs should remain valid for attachment links (in seconds). Useful for controlling access to embedded images and attachments in the exported document. | | `include_child_documents` | boolean | No | Whether to include child documents in the export. Using this option will always return a zip file containing the parent document and all its children. | #### 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 Attachment Redirect URL **Slug:** `OUTLINE_GET_ATTACHMENT_REDIRECT` Tool to retrieve an attachment redirect URL from Outline. Loads an attachment from where it is stored based on the id. If the attachment is private, a temporary signed URL with embedded credentials is generated on demand. Use when you need to access or download an attachment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the attachment. | #### 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 authentication config **Slug:** `OUTLINE_GET_AUTH_CONFIG` Tool to retrieve authentication configuration options for an Outline workspace. Use when you need to discover the workspace name, hostname, or available SSO/OAuth authentication services before user login. #### 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 Collection Info **Slug:** `OUTLINE_GET_COLLECTION` Tool to retrieve a collection by its unique identifier. Use when you need to fetch detailed information about a specific collection including its name, description, settings, and permissions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the collection (UUID format). | #### 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 Collection Documents **Slug:** `OUTLINE_GET_COLLECTION_DOCUMENTS` Tool to retrieve a collection's document structure as a tree of navigation nodes. Use when you need to explore the document hierarchy within a collection. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the collection. | #### 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 Comment **Slug:** `OUTLINE_GET_COMMENT` Tool to retrieve a comment by its ID from Outline. Use when you need to fetch detailed information about a specific comment including its content, author, timestamps, and resolution status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Comment ID to retrieve | | `includeAnchorText` | boolean | No | Include the document text that the comment is anchored to, if any, in the response. | #### 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 Document Info **Slug:** `OUTLINE_GET_DOCUMENT_INFO` Tool to retrieve a document from Outline by its UUID, urlId, or shareId. Returns complete document information including title, content, metadata, timestamps, and access policies. Use when you need to fetch document details or content. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Unique identifier for the document. Either the UUID or the urlId is acceptable. At least one of id or shareId must be provided. | | `shareId` | string | No | Unique identifier for a document share. A shareId may be used in place of a document UUID. At least one of id or shareId must be provided. | #### 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 Document Children Structure **Slug:** `OUTLINE_GET_DOCUMENTS_DOCUMENTS` Tool to retrieve a document's child structure. Returns the nested document tree (hierarchy) for the children of the specified document. Use when you need to explore document organization or navigate the document hierarchy. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document. Either the UUID or the urlId is acceptable. | #### 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 Operation Info **Slug:** `OUTLINE_GET_FILE_OPERATION_INFO` Tool to retrieve the details and current status of a file operation by its unique identifier. Use when you need to check the progress of import or export operations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the file operation. | #### 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 Group Info **Slug:** `OUTLINE_GET_GROUP_INFO` Tool to retrieve a group by its unique identifier. Returns group details including name and member count. Use when you need to fetch information about a specific group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the group (UUID format). | #### 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 OAuth Client Info **Slug:** `OUTLINE_GET_OAUTH_CLIENT_INFO` Tool to retrieve an OAuth client from Outline by its id or clientId. Returns complete OAuth client configuration including name, scopes, and redirect URIs. Use when you need to fetch OAuth client details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Unique identifier for the OAuth client. At least one of id or clientId must be provided. | | `clientId` | string | No | Public identifier for the OAuth client. At least one of id or clientId must be provided. | #### 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 Revision Info **Slug:** `OUTLINE_GET_REVISION_INFO` Tool to retrieve a revision by its ID from Outline. A revision is a snapshot of a document at a specific point in time. Use when you need to fetch historical document content or view editing history. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the revision. | #### 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 Share Info **Slug:** `OUTLINE_GET_SHARE_INFO` Tool to retrieve a share object by its unique identifier or by the associated document ID. Returns complete share information including URL, visibility settings, access permissions, and view statistics. Use when you need to fetch details about a shared document. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Unique identifier for the share. At least one of id or documentId must be provided. | | `documentId` | string | No | Unique identifier for a document. Retrieves the share for this document. At least one of id or documentId must be provided. | #### 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 Template Info **Slug:** `OUTLINE_GET_TEMPLATE_INFO` Tool to retrieve a template by its unique identifier. Use when you need to fetch detailed information about a specific template including its title, content, and metadata. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the template. Either the UUID or the urlId is acceptable. | #### 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 User Info **Slug:** `OUTLINE_GET_USER_INFO` Tool to retrieve a user by their unique identifier. Returns user details including name, email, avatar, role, and status. Use when you need to fetch information about a specific user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the user (UUID format). | #### 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 | ### Invite Users **Slug:** `OUTLINE_INVITE_USERS` Tool to invite users to the Outline workspace. Use when you need to send email invitations to one or more users to join the workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invites` | array | Yes | Array of user invitations containing email, name, and role for each user to invite | #### 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 Archived Documents **Slug:** `OUTLINE_LIST_ARCHIVED_DOCUMENTS` List all archived documents in the Outline workspace. Returns paginated archived documents that the current user has access to, with metadata and authorization policies. Use limit and offset for pagination through large result sets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of archived documents to return per request (default: 25, max: 100). Use for pagination to control result set size. | | `offset` | integer | No | Number of documents to skip before returning results (default: 0). Use with limit to paginate through archived documents. | #### 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 Collection Group Memberships **Slug:** `OUTLINE_LIST_COLLECTION_GROUP_MEMBERSHIPS` Tool to list all group memberships for a specific collection in Outline. Use when you need to see which groups have access to a collection and their permission levels. Returns both group details and membership relationships with permissions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Identifier for the collection (UUID format). This is the collection whose group memberships you want to retrieve. | | `limit` | integer | No | Maximum number of results to return per page. Use with offset for pagination. | | `query` | string | No | Search query to filter memberships by group names. Returns only groups whose names match the query string. | | `offset` | integer | No | Number of results to skip before returning data. Use with limit for pagination (e.g., offset=50 with limit=50 gets results 51-100). | | `permission` | string | No | Filter memberships by permission level (e.g., 'read', 'read_write'). Returns only memberships with the specified permission. | #### 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 collection memberships **Slug:** `OUTLINE_LIST_COLLECTION_MEMBERSHIPS` Tool to list all individual user memberships for a collection. Use when you need to see who has access to a specific collection and their permission levels. Note: This only returns individual user memberships, not group memberships. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the collection to list memberships for. | | `limit` | integer | No | Maximum number of results to return per page. | | `query` | string | No | Filter memberships by user names. Search string to match against user names. | | `offset` | integer | No | Number of results to skip for pagination. | | `permission` | string | No | Filter memberships by permission level (e.g., read, write, admin). | #### 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 Collections **Slug:** `OUTLINE_LIST_COLLECTIONS` Tool to list all collections that the authenticated user has access to. Use when you need to retrieve all collections, optionally filtered by name or status, with pagination and sorting support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field to sort collections by (e.g., 'name', 'updatedAt', 'createdAt') | | `limit` | integer | No | Maximum number of collections to return per page | | `query` | string | No | Search query to filter collections by name | | `offset` | integer | No | Number of collections to skip for pagination | | `direction` | string ("ASC" | "DESC") | No | Sort direction for collections. | | `statusFilter` | array | No | Filter collections by status (e.g., archived). Omit to include all statuses. | #### 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 Comments **Slug:** `OUTLINE_LIST_COMMENTS` Tool to retrieve all comments with optional filtering by document or collection. Use when you need to list comments, view comment threads, or monitor discussions. Supports pagination and sorting for large result sets. Returns comment data including content, authors, timestamps, and resolution status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field name to sort comments by (e.g., 'createdAt', 'updatedAt'). Determines the ordering of results. | | `limit` | integer | No | Maximum number of comments to return. Use for pagination to control response size. | | `offset` | integer | No | Number of comments to skip. Use with limit for pagination through large result sets. | | `direction` | string ("ASC" | "DESC") | No | Sort direction enum. | | `documentId` | string | Yes | UUID of the document to filter comments for. Required to list comments associated with a specific document. | | `collectionId` | string | No | Filter comments to a specific collection by its UUID. Returns only comments from documents in this collection. | | `includeAnchorText` | boolean | No | When true, includes the document text that the comment is anchored to in the response. Useful for providing context around inline comments. | #### 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 Data Attributes **Slug:** `OUTLINE_LIST_DATA_ATTRIBUTES` Tool to list all data attributes in Outline. Use when you need to retrieve custom data attributes that can be attached to documents for structured metadata. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field name to sort results by (e.g., 'name', 'updatedAt', 'createdAt'). | | `limit` | integer | No | Maximum number of data attributes to return in a single request. Default is typically 25. | | `offset` | integer | No | Number of results to skip for pagination. Use with limit to paginate through results. | | `direction` | string ("ASC" | "DESC") | No | Sort direction for listing data attributes. | #### 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 Deleted Documents **Slug:** `OUTLINE_LIST_DELETED_DOCUMENTS` Tool to list all deleted documents in the workspace that the current user has access to. Use when you need to retrieve, review, or restore documents that have been deleted. Supports pagination and sorting to efficiently navigate through large numbers of deleted documents. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field name to sort the results by (e.g., 'updatedAt', 'createdAt', 'title'). Controls the ordering of returned documents. | | `limit` | integer | No | Number of deleted documents to return per page. Use to control response size for pagination. | | `offset` | integer | No | Pagination offset - number of documents to skip. Use with limit to navigate through pages of results. | | `direction` | string | No | Sort direction for the results. Use 'ASC' for ascending order or 'DESC' for descending order. Only applicable when sort field is specified. | #### 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 Document Group Memberships **Slug:** `OUTLINE_LIST_DOCUMENT_GROUP_MEMBERSHIPS` Tool to list a document's group memberships. Use when you need to see which groups have access to a specific document and their permission levels. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The document identifier (UUID or urlId format) | | `limit` | integer | No | Maximum number of results to return for pagination | | `query` | string | No | Filter results by group names | | `offset` | integer | No | Number of results to skip for pagination | | `permission` | string | No | Filter by permission level (e.g., 'read', 'read_write') | #### 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 document memberships **Slug:** `OUTLINE_LIST_DOCUMENT_MEMBERSHIPS` Tool to list users with direct membership to a document. Use when you need to see who has direct access to a specific document and their permission levels. Note: This returns only users with direct memberships. To list all users with access to a document (including through group memberships), use documents.users instead. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document. Either the UUID or the urlId is acceptable. | | `query` | string | No | Filter results by user name. Search string to match against user names. | | `permission` | string ("read" | "read_write") | No | Permission levels for document access. | #### 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 Documents **Slug:** `OUTLINE_LIST_DOCUMENTS` Tool to list all documents in your Outline workspace. Returns published documents and draft documents belonging to the current user. Use filters to narrow results by collection, creator, status, or document relationships. Supports pagination for large document sets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field name to sort results by. Common values include 'title', 'createdAt', 'updatedAt'. Defaults to the API's default sorting. | | `limit` | integer | No | Maximum number of documents to return per page. Use for pagination to control result set size. | | `offset` | integer | No | Number of documents to skip before starting to return results. Use with limit for pagination (e.g., offset=50 with limit=25 returns items 51-75). | | `userId` | string | No | Unique identifier of the user to filter documents by creator. Only documents created by this user will be returned. Useful for viewing documents authored by a specific person. | | `direction` | string | No | Sort direction: 'ASC' for ascending or 'DESC' for descending. Only applies when sort parameter is provided. | | `collectionId` | string | No | Unique identifier of the collection to filter documents by. Only documents belonging to this collection will be returned. Useful for viewing all documents within a specific collection. | | `statusFilter` | array | No | Filter documents by status. Accepts an array with one or more of: 'draft', 'archived', or 'published'. When omitted, returns both published documents and drafts belonging to the current user. | | `parentDocumentId` | string | No | Unique identifier of a parent document. Returns child documents (sub-pages) of this parent document. Useful for navigating document hierarchies. | | `backlinkDocumentId` | string | No | Unique identifier of a document. Returns documents that contain backlinks to this document. Useful for finding all documents that reference a specific document. | #### 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 Document Users **Slug:** `OUTLINE_LIST_DOCUMENT_USERS` Tool to list all users with access to a document. Returns all users who have any level of access to the specified document. Use when you need to see who can view or edit a document. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document. Either the UUID or the urlId is acceptable. | | `query` | string | No | If set, will filter the results by user name. | | `userId` | string | No | If set, will filter the results to a specific user. | #### 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 Draft Documents **Slug:** `OUTLINE_LIST_DRAFT_DOCUMENTS` Tool to list all draft documents belonging to the current user. Use when you need to retrieve unpublished documents. Supports filtering by collection, date recency, pagination, and sorting. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field name to sort by (e.g., 'title', 'updatedAt', 'createdAt'). | | `limit` | integer | No | Maximum number of results per page. Must be >= 1. | | `offset` | integer | No | Starting position for results (pagination offset). Must be >= 0. | | `direction` | string ("ASC" | "DESC") | No | Sort direction. | | `dateFilter` | string ("day" | "week" | "month" | "year") | No | Date filter for documents by update recency. | | `collectionId` | string | No | Filter documents by collection UUID. Only returns drafts within the specified collection. | #### 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 Events **Slug:** `OUTLINE_LIST_EVENTS` Tool to list all events from the audit trail. Use when you need to track actions taken in the knowledge base, such as document creation, permission changes, or user activity. Events provide a comprehensive audit trail for compliance and monitoring. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Filter to a specific event type (e.g., 'collections.create', 'documents.update', 'users.signin'). Use this to track specific types of actions in the knowledge base. | | `sort` | string | No | Field name to sort events by (e.g., 'createdAt'). Determines the ordering of results. | | `limit` | integer | No | Maximum number of events to return per page. Use for pagination to control response size. | | `offset` | integer | No | Number of events to skip before starting to return results. Use with limit for pagination through large result sets. | | `actorId` | string | No | Filter events to those performed by a specific user. Provide the user's UUID to see all actions taken by that user. | | `auditLog` | boolean | No | When true, returns detailed events suitable for audit logging purposes. Use this to get comprehensive event information for compliance or security reviews. | | `direction` | string ("ASC" | "DESC") | No | Sort direction enum. | | `documentId` | string | No | Filter events to those related to a specific document. Provide the document's UUID to see its complete history. | | `collectionId` | string | No | Filter events to those related to a specific collection. Provide the collection's UUID to track all activities within that collection. | #### 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 File Operations **Slug:** `OUTLINE_LIST_FILE_OPERATIONS` Tool to list all file operations for the workspace. Returns background jobs for importing or exporting files, filtered by type. Use to monitor export/import progress and retrieve download URLs for completed operations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("export" | "import") | No | File operation type options. | | `limit` | integer | No | Maximum number of file operations to return per page. Use for pagination to control result set size. | | `offset` | integer | No | Number of file operations to skip before starting to return results. Use with limit for pagination (e.g., offset=25 with limit=25 returns items 26-50). | #### 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 Group Memberships **Slug:** `OUTLINE_LIST_GROUP_MEMBERSHIPS` Tool to list all members of a specific group in Outline. Use when you need to see which users belong to a group. Returns user details and membership relationships. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Identifier for the group (UUID format). This is the group whose members you want to retrieve. | | `limit` | integer | No | Maximum number of results to return per page. Use with offset for pagination. | | `query` | string | No | Search query to filter memberships by user names. Returns only users whose names match the query string. | | `offset` | integer | No | Number of results to skip before returning data. Use with limit for pagination (e.g., offset=50 with limit=50 gets results 51-100). | #### 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:** `OUTLINE_LIST_GROUPS` Tool to list all groups in the workspace. Groups organize users and manage permissions for collections. Use when you need to retrieve all groups, optionally filtered by name, with pagination and sorting support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field to sort groups by (e.g., 'name', 'updatedAt', 'createdAt') | | `limit` | integer | No | Maximum number of groups to return per page | | `query` | string | No | Search query to filter groups by name | | `offset` | integer | No | Number of groups to skip for pagination | | `direction` | string ("ASC" | "DESC") | No | Sort direction for 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 OAuth Authentications **Slug:** `OUTLINE_LIST_O_AUTH_AUTHENTICATIONS` Tool to list all OAuth authentications for the current user. Use when you need to see which third-party applications have been authorized to access the user's account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of OAuth authentications to return per page | | `offset` | integer | No | Number of OAuth authentications to skip for pagination | #### 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 OAuth Clients **Slug:** `OUTLINE_LIST_OAUTH_CLIENTS` Tool to list all OAuth clients accessible to the authenticated user. Use when you need to retrieve OAuth clients for third-party integrations. Returns both clients created by the user and published clients available to the workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of OAuth clients to return per page. Use for pagination to control response size. | | `offset` | integer | No | Number of OAuth clients to skip. Use with limit for pagination through large result sets. | #### 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 Recently Viewed Documents **Slug:** `OUTLINE_LIST_RECENTLY_VIEWED_DOCUMENTS` Tool to list all recently viewed documents by the current user. Returns documents ordered by when they were last viewed. Supports pagination and sorting for large result sets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field name to sort results by. Common values include 'title', 'createdAt', 'updatedAt', 'viewedAt'. Defaults to the API's default sorting. | | `limit` | integer | No | Maximum number of documents to return per page. Use for pagination to control result set size. | | `offset` | integer | No | Number of documents to skip before starting to return results. Use with limit for pagination (e.g., offset=50 with limit=25 returns items 51-75). | | `direction` | string | No | Sort direction: 'ASC' for ascending or 'DESC' for descending. Only applies when sort parameter is provided. | #### 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 Revisions **Slug:** `OUTLINE_LIST_REVISIONS` Tool to list all revisions for a specific document. Revisions represent historical snapshots of document content and are useful for tracking changes over time. Use when you need to view a document's editing history or restore to a previous version. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field name to sort revisions by (e.g., 'createdAt'). Determines the ordering of results. | | `limit` | integer | No | Maximum number of revisions to return per page. Use for pagination to control response size. | | `offset` | integer | No | Number of revisions to skip before starting to return results. Use with limit for pagination through large result sets. | | `direction` | string ("ASC" | "DESC") | No | Sort direction enum. | | `documentId` | string | Yes | Unique identifier of the document to retrieve revisions for. This is required to specify which document's revision history you want to access. | #### 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 Shares **Slug:** `OUTLINE_LIST_SHARES` Tool to list all share links in the workspace. Use when you need to retrieve all public document shares, optionally filtered by search query, with pagination and sorting support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field to sort shares by (e.g., 'updatedAt', 'createdAt') | | `limit` | integer | No | Maximum number of shares to return per page | | `query` | string | No | Filter to shared documents matching a search query | | `offset` | integer | No | Number of shares to skip for pagination | | `direction` | string ("ASC" | "DESC") | No | Sort direction for shares. | #### 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 Stars **Slug:** `OUTLINE_LIST_STARS` Tool to list all starred documents and collections for the authenticated user. Use when you need to retrieve bookmarked items that users have marked for quick access in their sidebar. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field name to sort stars by (e.g., 'createdAt'). Determines the ordering of results. | | `limit` | integer | No | Maximum number of starred items to return per page. Use for pagination to control response size. | | `offset` | integer | No | Number of starred items to skip before starting to return results. Use with limit for pagination through large result sets. | | `userId` | string | No | Filter starred items to those created by a specific user. Provide the user's UUID to see their bookmarked documents and collections. | | `direction` | string ("ASC" | "DESC") | No | Sort direction enum. | #### 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 Templates **Slug:** `OUTLINE_LIST_TEMPLATES` Tool to list all templates available to the current user. Use when you need to retrieve all templates, optionally filtered by collection or name, with pagination and sorting support. Templates not associated with a collection are workspace-wide. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field to sort templates by (e.g., 'title', 'createdAt', 'updatedAt') | | `limit` | integer | No | Maximum number of templates to return per page | | `query` | string | No | Search query to filter templates by name | | `offset` | integer | No | Number of templates to skip for pagination | | `direction` | string ("ASC" | "DESC") | No | Sort direction for templates. | | `collectionId` | string | No | Filter templates to a specific collection by its UUID. Templates not associated with a collection are workspace-wide. | #### 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 Users **Slug:** `OUTLINE_LIST_USERS` Tool to list all users in the workspace. Use when you need to retrieve all users, optionally filtered by name, email, or status, with pagination and sorting support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field to sort users by (e.g., 'name', 'email', 'createdAt', 'updatedAt', 'lastActiveAt') | | `limit` | integer | No | Maximum number of users to return per page | | `query` | string | No | Search query to filter users by name or email | | `filter` | string ("active" | "invited" | "suspended") | No | Filter users by status. | | `offset` | integer | No | Number of users to skip for pagination | | `direction` | string ("ASC" | "DESC") | No | Sort direction for users. | #### 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 Views **Slug:** `OUTLINE_LIST_VIEWS` Tool to list all users that have viewed a specific document and the overall view count. Use when you need to see who has accessed a document and how many times they've viewed it. Returns view records including first/last view timestamps and total view counts per user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `documentId` | string | Yes | Unique identifier of the document to retrieve views for. Returns all users who have viewed this document and the total view count. | | `includeSuspended` | boolean | No | Whether to include views from suspended users in the results. If true, views from suspended users will be included; if false or omitted, only active users are returned. | #### 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 | ### Move Document **Slug:** `OUTLINE_MOVE_DOCUMENT` Tool to move a document to a new location or collection in Outline. Use when you need to reorganize documents by moving them to a different collection or nesting them under a different parent document. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document. Either the UUID or the urlId is acceptable. | | `index` | number | No | The position index in the collection structure. Used to specify the order of the document within its parent or collection. | | `collectionId` | string | No | Collection ID to move the document to. If not provided along with parentDocumentId, the document retains its current collection. | | `parentDocumentId` | string | No | Parent document ID to nest the document under. If not provided, the document will be moved to the collection root. | #### 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 | ### Redirect File Operation **Slug:** `OUTLINE_REDIRECT_FILE_OPERATION` Tool to retrieve a file from Outline by file operation ID. Loads the resulting file from where it is stored based on the id. A temporary signed URL with embedded credentials is generated on demand. Use when you need to access or download an exported file. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the file operation. | #### 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 | ### Remove Collection Group **Slug:** `OUTLINE_REMOVE_COLLECTION_GROUP` Tool to remove a group from a collection, revoking access for all group members. Use when you need to remove group-level access to a collection. Note that members may retain access through other groups or individual memberships. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Identifier for the collection | | `groupId` | string | Yes | Group ID to remove from the collection | #### 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 | ### Remove Collection User **Slug:** `OUTLINE_REMOVE_COLLECTION_USER` Tool to remove a user from a collection. Use when you need to revoke a user's access to a specific collection in Outline. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Identifier for the collection from which the user will be removed | | `userId` | string | Yes | Identifier for the user to remove from the collection | #### 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 | ### Remove Document User **Slug:** `OUTLINE_REMOVE_DOCUMENT_USER` Tool to remove a user membership from a document. Use when you need to revoke a user's access to a specific document. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Document identifier. Either the UUID or the urlId is acceptable. | | `userId` | string | Yes | User ID of the user to remove from the document | #### 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 | ### Remove Group from Document **Slug:** `OUTLINE_REMOVE_GROUP_FROM_DOCUMENT` Tool to remove a group from a document, revoking access for all group members. Use when you need to revoke document-level access for an entire group at once. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document. Either the UUID or the urlId is acceptable. | | `groupId` | string | Yes | Unique identifier (UUID) for the group to remove from the document. | #### 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 | ### Remove Group User **Slug:** `OUTLINE_REMOVE_GROUP_USER` Tool to remove a user from a group. Use when you need to revoke a user's group membership in Outline. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Identifier for the group from which the user will be removed | | `userId` | string | Yes | Identifier for the user to remove from the group | #### 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 | ### Restore Document **Slug:** `OUTLINE_RESTORE_DOCUMENT` Tool to restore a document in Outline. If a document has been archived or deleted, it can be restored. Optionally a revision can be passed to restore the document to a previous point in time. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document. Either the UUID or the urlId is acceptable. | | `revisionId` | string | No | Identifier for the revision to restore to. If provided, the document will be restored to a previous point in time. | | `collectionId` | string | No | Identifier for the collection to restore the document to. If not provided, the document will be restored to its original collection. | #### 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 | ### Restore Template **Slug:** `OUTLINE_RESTORE_TEMPLATE` Tool to restore a previously deleted template in Outline. Use when you need to recover a template that was soft-deleted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the template. Either the UUID or the urlId is acceptable. | #### 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 | ### Retrieve Auth Info **Slug:** `OUTLINE_RETRIEVE_AUTH_INFO` Tool to retrieve authentication details for the current API key. Use when you need to verify that an API token is valid or obtain identifying information for the authenticated user and workspace. #### 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 | ### Revoke Share **Slug:** `OUTLINE_REVOKE_SHARE` Tool to revoke a share in Outline, making the share link inactive so it can no longer be used to access the document. Use when you need to disable public access to a shared document. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier (UUID) of the share to revoke. Once revoked, the share link will become inactive and can no longer be used to access the document. | #### 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 | ### Rotate OAuth Client Secret **Slug:** `OUTLINE_ROTATE_OAUTH_CLIENT_SECRET` Tool to rotate the secret for an OAuth client in Outline. Use when you need to generate a new client secret for an OAuth client. The old secret will be invalidated immediately. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the OAuth client. Rotating the secret will generate a new client secret and invalidate the old one immediately. | #### 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 | ### Search Documents **Slug:** `OUTLINE_SEARCH_DOCUMENTS` Tool to search all documents in your Outline workspace using keywords. Results are restricted to documents accessible by the current access token. Use filters to narrow results by collection, user, status, or timeframe. Supports sorting by relevance, date, or title. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string | No | Field name to sort results by. Accepted values: 'relevance' (default, best match first), 'createdAt', 'updatedAt', or 'title'. | | `limit` | integer | No | Maximum number of documents to return per page. Use for pagination to control result set size. | | `query` | string | Yes | Search keywords to find matching documents. Use natural language search terms. Required parameter. | | `offset` | integer | No | Number of documents to skip before starting to return results. Use with limit for pagination (e.g., offset=50 with limit=25 returns items 51-75). | | `userId` | string | No | Unique identifier of the user. Filters documents edited by this specific user. Useful for finding documents modified by a team member. | | `shareId` | string | No | Filters search by collection or document referenced via share ID. Use this when working with shared document links. | | `direction` | string | No | Sort direction: 'ASC' for ascending or 'DESC' for descending. Only applies when sort parameter is provided. | | `dateFilter` | string | No | Limits results to documents within specified timeframe. Accepted values: 'day' (last 24 hours), 'week' (last 7 days), 'month' (last 30 days), or 'year' (last 365 days). | | `documentId` | string | No | Unique identifier of a document. Searches within this document and all its children (sub-pages). Useful for searching within a specific document hierarchy. | | `collectionId` | string | No | Unique identifier of the collection. Restricts search to documents within this particular collection only. | | `statusFilter` | array | No | Filter documents by status. Accepts an array with one or more of: 'draft', 'archived', or 'published'. When omitted, searches across all statuses accessible to the user. | #### 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 | ### Search Document Titles **Slug:** `OUTLINE_SEARCH_DOCUMENT_TITLES` Tool to search document titles in Outline workspace using keywords. Unlike full document search, this searches only titles and returns faster results. Use when you need to quickly find documents by their title. Supports filters for collection, creator, status, and date range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("relevance" | "createdAt" | "updatedAt" | "title") | No | Sort field options for search results. | | `limit` | integer | No | Maximum number of documents to return per page. Use for pagination to control result set size. | | `query` | string | Yes | Search query to match against document titles. This searches only titles, not content, for faster results. | | `offset` | integer | No | Number of documents to skip before starting to return results. Use with limit for pagination (e.g., offset=50 with limit=25 returns items 51-75). | | `userId` | string | No | Filter results by document creator. Only documents created by this user will be returned. | | `shareId` | string | No | Filter results for the collection or document referenced by the shareId. Useful for searching within shared content. | | `direction` | string ("ASC" | "DESC") | No | Sort direction options. | | `dateFilter` | string ("day" | "week" | "month" | "year") | No | Date filter period values. | | `documentId` | string | No | Filter results to content within a specific document and its children. Useful for searching within a document hierarchy. | | `collectionId` | string | No | Filter results to a specific collection by its UUID. Only documents within this collection will be returned. | | `statusFilter` | array | No | Filter documents by status. Accepts an array with one or more of: draft, archived, or published. When omitted, returns published documents and drafts belonging to the current user. | #### 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 | ### Suspend User **Slug:** `OUTLINE_SUSPEND_USER` Tool to suspend a user in Outline. Suspending a user prevents them from signing in and they are not counted against billing totals. Use when you need to temporarily disable a user's access without deleting their account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the user. | #### 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 Template from Document **Slug:** `OUTLINE_TEMPLATIZE_DOCUMENT` Tool to create a template from an existing Outline document. Use when you need to convert a document into a reusable template for your workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document to convert into a template. Either the UUID or the urlId is acceptable. | | `publish` | boolean | Yes | Whether the new template should be published. Set to true to make the template immediately available to workspace members. | | `collectionId` | string | No | Identifier for the collection where the template should be created. If not provided, the template will be created in the same collection as the source document. | #### 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 | ### Unpublish Document **Slug:** `OUTLINE_UNPUBLISH_DOCUMENT` Tool to unpublish a document in Outline. Unpublishing moves the document back to draft status and removes it from the collection. Use when you need to make a published document private again. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document. Either the UUID or the urlId is acceptable. | | `detach` | boolean | No | Whether to detach the document from the collection. If true, the document will be removed from the collection structure when unpublished. | #### 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 | ### Update Collection **Slug:** `OUTLINE_UPDATE_COLLECTION` Tool to update an existing collection's properties in Outline. Use when you need to modify collection settings such as name, description, icon, color, sharing settings, or permission level. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the collection to update | | `icon` | string | No | A string that represents an icon in the outline-icons package or an emoji | | `name` | string | No | New name for the collection | | `color` | string | No | A hex color code for the collection icon | | `sharing` | boolean | No | Whether public sharing of documents is allowed | | `permission` | string | No | Permission level for the collection (read/write) | | `description` | string | No | New description for the collection, markdown supported | #### 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 | ### Update Comment **Slug:** `OUTLINE_UPDATE_COMMENT` Tool to update a comment in Outline. Use when you need to modify the content of an existing comment. The comment body should be provided in ProseMirror document format with type and content fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier for the comment to update (UUID format). | | `data` | object | Yes | The comment body content in ProseMirror document format. Should include 'type' (typically 'doc') and 'content' array with paragraph objects containing text nodes. | #### 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 | ### Update Document **Slug:** `OUTLINE_UPDATE_DOCUMENT` Tool to update a document in Outline. Use when you need to modify an existing document's title, content, or metadata. At least the document ID is required. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the document. Either the UUID or the urlId is acceptable. | | `icon` | string | No | Icon displayed alongside the document title | | `text` | string | No | The body of the document in markdown. | | `color` | string | No | Color for the document icon in hex format | | `title` | string | No | The title of the document. | | `publish` | boolean | No | Whether this document should be published and made visible to other workspace members, if a draft | | `editMode` | string | No | Edit mode | | `fullWidth` | boolean | No | Whether the document should be displayed in full width | | `templateId` | string | No | Identifier for the template this document is based on | | `collectionId` | string | No | Identifier for the collection to move the document to | | `dataAttributes` | array | No | Data attributes to be updated. Attributes not included will be removed from the document. | | `insightsEnabled` | boolean | No | Whether insights should be visible on the document | #### 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 | ### Update Group **Slug:** `OUTLINE_UPDATE_GROUP` Tool to update an existing group's name in Outline. Use when you need to rename a group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Group ID (UUID). The unique identifier of the group to update. | | `name` | string | Yes | New name for the group. | #### 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 | ### Update OAuth Client **Slug:** `OUTLINE_UPDATE_O_AUTH_CLIENT` Tool to update an existing OAuth client in Outline. Use when you need to modify an OAuth client's properties such as name, description, redirect URIs, or published status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the OAuth client to update | | `name` | string | No | Name of the OAuth client | | `avatarUrl` | string | No | A URL pointing to an image representing the OAuth client | | `published` | boolean | No | Whether the OAuth client is available to other workspaces | | `description` | string | No | A short description of this OAuth client | | `developerUrl` | string | No | The URL of the developer who created this OAuth client | | `redirectUris` | array | No | List of redirect URIs for the OAuth client. These URIs are used for OAuth callbacks after authentication | | `developerName` | string | No | The name of the developer who created this OAuth client | #### 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 | ### Update Share **Slug:** `OUTLINE_UPDATE_SHARE` Tool to update a share in Outline. Use when you need to change a share's published status, which controls whether authentication is required to access the shared link. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier for the share to update (UUID format). | | `published` | boolean | Yes | Published status. When true, removes authentication and makes the share available to anyone with the link. When false, authentication is required. | #### 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 | ### Update Star **Slug:** `OUTLINE_UPDATE_STAR` Tool to update a star's position in the Outline sidebar. Use when you need to reorder a user's starred documents or collections by changing the display index. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier (UUID) of the star to update. This determines which starred item's position will be changed in the sidebar. | | `index` | string | Yes | The new position index for the star in the sidebar. Determines the display order relative to other starred documents. Lower numbers appear higher in the list. | #### 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 | ### Update Template **Slug:** `OUTLINE_UPDATE_TEMPLATE` Tool to update an existing template in Outline. Use when you need to modify a template's title, content, icon, color, or other properties. At least the template ID is required. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the template. Either the UUID or the urlId is acceptable. | | `data` | object | No | The body of the template as a Prosemirror document. Must be a valid Prosemirror JSON structure with type, content, and other required fields. | | `icon` | string | No | An emoji to use as the template icon. | | `color` | string | No | The color of the template icon in hex format. | | `title` | string | No | The title of the template. | | `fullWidth` | boolean | No | Whether the template should be displayed full width. | | `collectionId` | string | No | Identifier for the collection to which the template belongs. Set to null for a workspace-wide template. | #### 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 | ### Update User **Slug:** `OUTLINE_UPDATE_USER` Tool to update a user's name, avatar, or language preference in Outline. If no ID is provided, updates the authenticated user. Use when you need to modify user profile information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Unique identifier for the user to update. If not provided, updates the authenticated user. | | `name` | string | No | User name to update. | | `language` | string | No | Language preference for the user. | | `avatarUrl` | string | No | URL to the user's avatar image. | #### 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 | ### Update User Role **Slug:** `OUTLINE_UPDATE_USER_ROLE` Tool to change a user's role in Outline workspace. Use when you need to promote a user to admin, demote an admin to member, or change a user to viewer role. Only available to admin users. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Unique identifier for the user whose role you want to change (UUID format). | | `role` | string ("admin" | "member" | "viewer" | "guest") | Yes | New role to assign to the user. Admin: full permissions. Member: standard workspace access. Viewer: read-only access. | #### 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 |