Outline

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.

Untrusted display-only summary

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.

Untrusted display-only summary

Tool to add a user membership to a document. Use when you need to grant a user access to a specific document.

Untrusted display-only summary

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.

Untrusted display-only summary

Tool to add a user to a group. Use when you need to grant a user membership in a specific group.

Untrusted display-only summary

Tool to add a user to a collection with specified permissions. Use when you need to grant a user access to a specific collection.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

Tool to create a new group in Outline. Use when you need to organize users into logical groups for easier permission management across collections.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary