Reference

Create Attachment

Prepare attachments for upload to your Outline documents by creating database records that enable secure file transfers to cloud storage.

Delete Attachment

Permanently remove an attachment from your Outline workspace to clean up unused files and free up storage space. Note that existing references to the deleted attachment in documents will remain.

Get Attachment Redirect URL

Retrieves a direct URL to download or access an attachment stored in Outline, automatically generating secure temporary links for private files.

List Data Attributes

Retrieve all custom data attributes available in Outline that can be attached to documents, helping you organize and structure document metadata for better organization and searchability.

Get authentication config

Retrieves the authentication configuration details for your Outline workspace, including workspace name, hostname, and available authentication methods. Use this to understand how users can log in and what authentication options are available before directing them to the login process.

Retrieve Auth Info

Verifies your API connection is active and retrieves identifying information about your authenticated account and workspace. Use this to confirm your integration is properly configured and working.

Create Collection

Create a new collection in Outline to organize and group related documents with customizable settings like name, description, icon, and color for better content management.

List Collections

Retrieve all collections you have access to in your workspace, with options to filter by name or status and sort results. This helps you discover and organize your available content collections.

Add Group to Collection

Grant all members of a group access to a specific collection in Outline with read or write permissions, enabling team collaboration on shared documents and resources.

Add User to Collection

Grant a team member or collaborator access to a specific collection by adding them with defined permission levels, enabling controlled sharing of documents and resources.

Delete Collection

Permanently remove a collection and all its documents from Outline. This action cannot be reversed, so ensure you no longer need the content before deleting.

Export All Collections

Exports all collections and documents from your workspace at once, providing a complete backup or archive of your content. Useful for safeguarding important information or preparing data for migration.

Export Collection

Download all documents and attachments from a collection in your preferred format (markdown, JSON, or HTML), automatically organized into folders if they're nested. Useful for backing up, migrating, or sharing entire knowledge bases.

Get Collection Documents

Retrieves the hierarchical structure of documents within a collection to help you understand and navigate your knowledge base organization. This is useful when you need to see how documents are organized or find specific content within a collection.

Get Collection Info

Retrieve detailed information about a specific collection including its name, description, settings, and permissions. Use this when you need to access or verify collection details for organizational or management purposes.

List Collection Group Memberships

Retrieve all groups that have access to a specific collection in Outline along with their permission levels, helping you understand who can access your shared documents and what they can do with them.

List collection memberships

Retrieve a list of all individual users who have access to a specific collection along with their permission levels. Use this to understand who can view, edit, or manage content within that collection.

Remove Collection Group

Removes a group's access to a collection, preventing all group members from viewing or collaborating on that collection's documents. Use this when you need to revoke team-level permissions or reorganize who can access specific documentation.

Remove Collection User

Remove a team member's access to a specific collection in Outline, instantly revoking their ability to view or edit those documents.

Update Collection

Modify an existing collection's properties including name, description, icon, color, and sharing settings to keep your knowledge base organized and relevant. Use this to rename collections, update descriptions, change visual appearance, or adjust access permissions for team members.

Create Comment

Add comments or replies to your Outline documents to provide feedback, ask questions, or collaborate with others on specific content.

Delete Comment

Remove unwanted comments from your Outline documents, with nested replies automatically deleted if you remove a top-level comment. Use this to clean up feedback, remove spam, or manage document discussions.

Get Comment

Retrieve the full details of a specific comment from your Outline documentation, including who wrote it, when, and its current status. Use this to track feedback, review discussions, or pull comment information into your workflows.

List Comments

Retrieve all comments from your documents with filtering and sorting capabilities to view discussions and feedback. Useful for tracking feedback across documents and managing comment threads in one place.

Update Comment

Modify the content of an existing comment in Outline to correct errors, add clarifications, or update information after it's been posted.

Create Document

Create a new document in Outline with a title and content, optionally publishing it directly to a collection or as a draft for later refinement.

List Documents

Retrieve all documents from your Outline workspace with optional filtering by collection, creator, or status to organize and locate your content quickly.

Search Documents

Find specific documents across your Outline workspace using keywords and filters like collection, user status, and date range. Quickly locate information without manually browsing through all your files.

Update Document

Modify an existing document in Outline by updating its title, content, or metadata to keep your knowledge base and documentation current.

Add Document User

Grant a team member or collaborator access to a specific document so they can view and work on it.

Add Group to Document

Grant document access to an entire group at once, eliminating the need to add individual members manually. Streamlines permission management when multiple team members need immediate access to the same document.

Archive Document

Move outdated documents out of active view while keeping them searchable and restorable for future reference. This helps maintain an organized knowledge base without permanently losing important information.

Delete Document

Remove a document from Outline by moving it to trash, with the option to permanently delete it immediately. This helps keep your workspace organized by removing outdated or unnecessary documents.

Duplicate Document

Creates an exact copy of an Outline document with the option to include all nested child documents, allowing you to quickly reuse existing document structures and content.

Empty Documents Trash

Permanently removes all trashed documents from your workspace, freeing up storage and cleaning up your document organization. This is useful when you've finished reviewing deleted items and want to fully remove them from the system.

Export Document

Download or extract document content from Outline in your preferred format (Markdown, HTML, or PDF) for external use, sharing, or archiving.

Get Document Children Structure

Retrieves the hierarchical structure of child documents within a parent document, showing you how your content is organized. This helps you understand your document's layout and locate specific content within nested folders.

Get Document Info

Retrieve detailed information about a document in Outline using its unique identifier, including the document title, full content, metadata, and timestamps. Use this to access document details when you need to reference, analyze, or display document information in your workflow.

List Archived Documents

Retrieve all archived documents from your Outline workspace with pagination support, allowing you to view and manage documents you've set aside but need to reference or restore.

List Deleted Documents

Retrieve all deleted documents from your workspace to find, review, or restore documents that have been removed. This helps you recover important information or permanently clean up your workspace.

List Document Group Memberships

Retrieve all groups that have access to a specific document along with their permission levels, helping you understand who can view, edit, or manage that document.

List document memberships

Retrieve a list of all users who have direct access to a specific document along with their permission levels, helping you understand who can view and edit your documents.

List Document Users

Retrieve all users who have access to a specific document to manage sharing and permissions. This helps you understand who can view or edit your documents and maintain proper access control.

List Draft Documents

Retrieve all your unpublished documents with filtering and sorting options to help you organize and manage work-in-progress content. This lets you quickly find drafts by collection, date, or sort order without cluttering your view with published items.

List Recently Viewed Documents

Retrieve a list of documents you've recently accessed, ordered by when you last viewed them, with support for pagination and sorting to easily find files you're actively working with.

Move Document

Move documents between collections or reorganize your document hierarchy in Outline by reassigning parent locations. This helps you keep your knowledge base structured as your business needs evolve.

Remove Document User

Revokes a user's access to a specific document, preventing them from viewing or collaborating on that content anymore.

Remove Group from Document

Instantly revoke document access for an entire group of users in one action, ensuring sensitive information is no longer visible to all group members at once.

Restore Document

Restore a previously archived or deleted document in Outline, optionally returning it to a specific earlier version. This helps you recover important documentation that was removed or needs to be reverted to a previous state.

Search Document Titles

Quickly locate documents in your Outline workspace by searching their titles, with filtering options for collections, creators, and date ranges to narrow results efficiently.

Unpublish Document

Removes a published document from your Outline collection and reverts it to draft status, making it private again.

List Events

Retrieve all events from your knowledge base's audit trail to track actions like document creation, updates, and permission changes for compliance and accountability.

Create Star

Mark a document or collection as a favorite in Outline so it appears prominently in your sidebar for quick access to frequently used resources.

Delete Star

Remove a star from a document in Outline to clean up your saved documents list and keep only the most relevant starred items.

List Stars

Retrieve all documents and collections you've starred for quick access, helping you organize and find your most important work instantly.

Update Star

Reorganize your starred documents and collections in Outline by changing their display order, helping you prioritize the most important resources at the top of your sidebar.

Delete File Operation

Remove completed or failed file operations and their associated files from your Outline workspace to keep your import/export history clean and organized.

Get File Operation Info

Check the progress and status of file import or export operations in your workspace by retrieving real-time details about ongoing file transfers.

List File Operations

Monitor and retrieve the status of file import and export operations in your workspace, including download links for completed exports.

Redirect File Operation

Fetch and access exported files from Outline using a file operation ID, generating a temporary download link that's ready to use immediately without additional authentication setup.

Add User to Group

Assigns a user to a group within your workspace, enabling them to access shared resources and collaborate on group-specific content. This simplifies permission management by organizing team members into functional groups.

Create Group

Create a new group in Outline to organize team members and manage permissions across your knowledge base collections. This helps you control who can access and edit specific documents without managing individual permissions one by one.

Delete Group

Removes a group from Outline, immediately revoking all members' access to collections the group was previously added to. Use this to clean up team structures or remove access when group members change roles.

Get Group Info

Retrieve detailed information about a specific group including its name and member count by using its unique identifier.

List Group Memberships

Retrieve all members belonging to a specific group in Outline to see who has access and what team structures you've created. This helps you manage group composition and understand your team organization at a glance.

List Groups

Retrieve all groups in your workspace to see how users are organized and which collections each group can access. This helps you understand your team structure and manage permissions effectively.

Remove Group User

Removes a user from a group in Outline, revoking their access to group-specific documents and collaboration spaces. This helps you maintain organized team permissions and control who can view sensitive information.

Update Group

Rename an existing group in Outline to better organize your team's documentation and knowledge base. This helps keep your workspace structure clear and aligned with your current organizational needs.

Create OAuth Client

Generate a new OAuth client application to enable secure third-party integrations with your Outline workspace and manage programmatic access to your knowledge base.

Delete OAuth Authentication

Removes a third-party application's access to your Outline account, disconnecting the OAuth authentication link between Outline and that external service.

Delete OAuth Client

Permanently remove an OAuth client from Outline and revoke all associated access tokens, ensuring that disconnected applications can no longer access your workspace.

Get OAuth Client Info

Retrieves the complete configuration details of an OAuth client from Outline, including its name, authorized scopes, and redirect URIs. This helps you verify or audit the authentication setup for your integrated applications.

List OAuth Authentications

View all third-party applications that have been granted access to your account, helping you manage which apps can interact with your data and services.

List OAuth Clients

Retrieve all OAuth clients available to your workspace, including those you've created and published integrations that others have shared. This helps you manage third-party application connections and permissions.

Rotate OAuth Client Secret

Generate a new security credential for an OAuth application in Outline, immediately disabling the previous one to maintain security.

Update OAuth Client

Modify the settings and properties of an OAuth client in Outline, such as its name, description, redirect URLs, or publication status.

Get Revision Info

Retrieve a specific snapshot of a document from Outline to access historical versions and see how your content has changed over time.

List Revisions

Retrieve the complete history of edits and versions for a document, allowing you to see what changes were made and when. This helps you track document evolution and identify who modified what content over time.

Create Share

Generate a public shareable link for your Outline documents that anyone can access without needing workspace membership, making it easy to share knowledge with clients, contractors, or the public.

Get Share Info

Retrieve detailed information about a shared document including its access URL, visibility settings, permissions, and view statistics. Use this to monitor how your documents are being shared and who has access to them.

List Shares

Retrieve all public document share links in your workspace to manage access and track which documents are publicly shared. This helps you monitor what content is available to external users and find specific shares quickly.

Revoke Share

Disable a previously shared document link in Outline so it can no longer be accessed, giving you control over who can view your content.

Update Share

Modify the access settings of a shared document link in Outline, including whether viewers need to authenticate to access it.

Create Template

Create a reusable document template in Outline that serves as a starting point for new documents, with the option to restrict it to a specific collection. This saves time by standardizing document formats and ensuring consistency across your team's knowledge base.

Create Template from Document

Converts an existing Outline document into a reusable template that you can apply to future documents, saving time on repetitive formatting and structure.

Delete Template

Remove a template from your Outline workspace while keeping the option to restore it later if needed.

Duplicate Template

Creates a copy of an existing template with the option to give it a new name or place it in a different collection, allowing you to reuse template designs without building from scratch.

Get Template Info

Retrieve detailed information about a specific template, including its title, content, and metadata. This helps you quickly access template details to reuse or modify existing document structures.

List Templates

Retrieve all available templates for your workspace, with optional filtering by collection or name and sorting options. Use this to discover and organize reusable document structures and content templates.

Restore Template

Recover a template that you previously deleted from Outline, allowing you to quickly restore important document structures without recreating them from scratch.

Update Template

Modify an existing template in Outline by updating its title, content, icon, color, or other properties to keep your documentation resources current and relevant.

Invite Users

Send email invitations to team members to join your Outline workspace, allowing them to access shared documents and collaborate on knowledge management.

Activate User

Restore access for a suspended user in Outline so they can sign in again and collaborate with your team. This is useful when you need to re-enable a team member's account.

Delete User

Permanently removes a user account from your Outline workspace, ensuring they can no longer access any documents or collaborate with your team.

Get User Info

Retrieve detailed information about a specific user including their name, email, avatar, role, and account status. Useful for displaying user profiles, verifying user details, or managing team member information.

List Users

Retrieve a complete list of all users in your workspace with optional filtering by name, email, or status to manage team members and monitor access.

Suspend User

Temporarily disable a user's access to your Outline workspace without deleting their account, preventing them from signing in while preserving their work and reducing billing costs.

Update User

Modify user profile information such as name, avatar, or language preference in Outline. Useful when you need to keep user accounts current or personalize the workspace experience.

Update User Role

Change a team member's access level in your Outline workspace, allowing you to promote contributors to administrators, demote admins back to members, or restrict someone to viewer-only access.

Create View

Records when a document has been viewed in Outline, helping you track document engagement and readership across your team.

List Views

Track who has viewed your documents and how frequently they've accessed them, helping you understand document engagement and audience interest.