The Outline connector lets your AI agent act in each user's Outline account. Each user signs in to Outline once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 82 tools.
- Tools
- 82
- What they doRead · write · destructive
- 42 · 29 · 1142 read29 write11 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own Outline app
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Outline connection
In AgentKit > Connections, create an Outline connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.Register an OAuth app
Outline connections use your own OAuth app. Register one with Outline and add the redirect URI you copied.
Then enter the app's Client ID and Client Secret on the Outline connection.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'outline'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Outline:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'outline_current_user_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "outline"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Outline:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="outline_current_user_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_tooloutline_attachments_listList files attached in the workspace, optionally for one document or uploaded by one user.Read-onlyList Attachments
List files attached in the workspace, optionally for one document or uploaded by one user. Returns attachments with id, name, contentType, size, documentId and url, plus pagination. Use outline_attachments_list to find uploaded files. Use outline_attachment_create_from_url to add one from a link.
Inputs
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC document_idstring- UUID of a document whose attachments to list. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
sortstring- Field to sort results by, such as updatedAt, createdAt, title or index. Example: updatedAt.
user_idstring- UUID of a user whose uploads to list. Get it from outline_users_list or outline_current_user_get.
outline_collection_getGet one collection by its ID.Read-onlyGet Collection
Get one collection by its ID. Returns the collection's id, name, description, icon, color, permission, sharing settings and timestamps. Use outline_collection_get for a collection's details. Use outline_collection_structure_get for the documents inside it.
Inputs
idstringrequired- UUID of the collection. Get it from outline_collections_list.
outline_collection_group_memberships_listList the groups that have access to a collection and their permission.Read-onlyList Collection Group Memberships
List the groups that have access to a collection and their permission. Returns group memberships with the group and permission, plus pagination. Use outline_collection_group_memberships_list to audit team access. Use outline_collection_memberships_list for individual users.
Inputs
idstringrequired- UUID of the collection. Get it from outline_collections_list.
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
permissionstring- Only return memberships with this access level: `read` or `read_write`.one of
readread_write querystring- Text to filter results by group name. Example: developers.
outline_collection_memberships_listList users with an individual membership on a collection and their permission.Read-onlyList Collection Memberships
List users with an individual membership on a collection and their permission. Group access is not included. Returns memberships (user, permission) and the related users, plus pagination. Use outline_collection_memberships_list to audit who was added directly. Use outline_collection_group_memberships_list for groups.
Inputs
idstringrequired- UUID of the collection. Get it from outline_collections_list.
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
permissionstring- Only return memberships with this access level: `read` or `read_write`.one of
readread_write querystring- Text to filter results by user name. Example: jenny.
outline_collection_structure_getGet the document tree of a collection: every published document and how they nest.Read-onlyGet Collection Document Tree
Get the document tree of a collection: every published document and how they nest. Returns a list of navigation nodes, each with id, title, url and its children. Use outline_collection_structure_get to see a collection's hierarchy. Use outline_documents_list for a flat, paged list with document text.
Inputs
idstringrequired- UUID of the collection. Get it from outline_collections_list.
outline_collections_listList the collections the user can access, optionally filtered by name.Read-onlyList Collections
List the collections the user can access, optionally filtered by name. Returns collections with id, name, description, icon, color, permission, sharing and timestamps, plus pagination. Use outline_collections_list to find a collection ID. Use outline_collection_get for one collection, or outline_collection_structure_get for its document tree.
Inputs
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC filtersarray- Advanced structured filters, combined with AND. Each entry is a condition with a field, an operator and usually a value, or a group with an operator of AND or OR and its own list of filters. Supported fields: name, createdAt, updatedAt, archivedAt, createdById and permission. Operators include eq, neq, lt, lte, gt, gte, contains, startsWith, endsWith, in, notIn, isNull and isNotNull. Date fields accept an ISO 8601 date or an ISO 8601 duration relative to now. Example: [{"field": "updatedAt", "operator": "gte", "value": "2026-01-01"}].
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
name_containsstring- Only return collections whose name contains this text. Example: Engineering.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
sortstring- Field to sort results by, such as updatedAt, createdAt, title or index. Example: updatedAt.
outline_comment_getGet one comment by ID.Read-onlyGet Comment
Get one comment by ID. Returns the comment's id, documentId, parentCommentId, body, createdBy, resolvedAt and timestamps. Use outline_comment_get for a single comment. Use outline_comments_list for a whole discussion.
Inputs
idstringrequired- UUID of the comment. Get it from outline_comments_list.
include_anchor_textboolean- Set to true to include the document text the comment is attached to, if it is an inline comment.
outline_comments_listList comments on a document or across a collection.Read-onlyList Comments
List comments on a document or across a collection. Returns comments with id, documentId, parentCommentId, the comment body, createdBy, resolvedAt and timestamps, plus pagination. Use outline_comments_list to read a discussion. Use outline_comment_get for a single comment.
Inputs
collection_idstring- UUID of a collection to list comments for. Get it from outline_collections_list.
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC document_idstring- UUID of a document to list comments for. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
include_anchor_textboolean- Set to true to include the document text each inline comment is attached to.
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
sortstring- Field to sort results by, such as updatedAt, createdAt, title or index. Example: updatedAt.
outline_current_user_getGet the Outline user and workspace that the connected account is signed in as.Read-onlyGet Current User
Get the Outline user and workspace that the connected account is signed in as. Returns the user (id, name, email, role, avatar) and the team (id, name, URL, settings). Use outline_current_user_get to find your own user ID or workspace URL. Use outline_user_get to look up another user.
Inputs
This tool takes no inputs.
outline_document_children_getGet the tree of documents nested under a document.Read-onlyGet Child Document Tree
Get the tree of documents nested under a document. Returns navigation nodes for each child, with id, title, url and their own children. Use outline_document_children_get to see what sits under a page. Use outline_collection_structure_get for a whole collection.
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
outline_document_exportExport a document's content as Markdown.Read-onlyExport Document as Markdown
Export a document's content as Markdown. Returns the document body as a Markdown string in data. Use outline_document_export when you only need the text. Use outline_document_get for the text plus title, IDs and metadata.
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
outline_document_getGet one Outline document by its ID or urlId, including its full Markdown text.Read-onlyGet Document
Get one Outline document by its ID or urlId, including its full Markdown text. Returns the document's id, urlId, title, text (Markdown), collectionId, parentDocumentId, createdBy, updatedBy, timestamps and url. Use outline_document_get to read a document you already know. Use outline_documents_search to find documents by content, or outline_document_export to get the content only.
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
outline_document_group_memberships_listList the groups that have access to a document and their permission.Read-onlyList Document Group Memberships
List the groups that have access to a document and their permission. Returns group memberships with the group and permission, plus pagination. Use outline_document_group_memberships_list to audit group access. Use outline_document_memberships_list for individual users.
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
permissionstring- Only return memberships with this access level: `read` or `read_write`.one of
readread_write querystring- Text to filter results by group name. Example: engineering.
outline_document_memberships_listList users with a direct membership on a document and their permission.Read-onlyList Document Memberships
List users with a direct membership on a document and their permission. Returns memberships (user, permission) and the related users. Use outline_document_memberships_list to audit direct access. Use outline_document_users_list for everyone with access, or outline_document_group_memberships_list for groups.
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
permissionstring- Only return memberships with this access level: `read` or `read_write`.one of
readread_write querystring- Text to filter results by user name. Example: jenny.
outline_document_users_listList every user who has access to a document, through the collection, a group or a direct membership.Read-onlyList Document Users
List every user who has access to a document, through the collection, a group or a direct membership. Returns users with id, name, email and role. Use outline_document_users_list to see who can open a document. Use outline_document_memberships_list for direct memberships only.
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
querystring- Text to filter results by user name. Example: jenny.
user_idstring- UUID of a user to check for. Get it from outline_users_list or outline_current_user_get.
outline_documents_answer_questionAsk a natural-language question and get an AI-written answer drawn from the documents the user can access.Read-onlyAnswer Question from Documents
Ask a natural-language question and get an AI-written answer drawn from the documents the user can access. Returns search.answer with the answer text, plus the documents it drew on. Use outline_documents_answer_question for a direct answer. Use outline_documents_search to get matching documents instead. AI answers must be enabled for the Outline workspace.
Inputs
querystringrequired- The question to answer. Example: What is our holiday policy?
collection_idstring- UUID of a collection to search within. Get it from outline_collections_list.
date_filterstring- Only use documents updated within this period: day, week, month or year.one of
dayweekmonthyear document_idstring- UUID of a document to search within. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
status_filterstring- Only use documents with this status: draft, archived or published.one of
draftarchivedpublished user_idstring- UUID of a user; only documents they edited are used. Get it from outline_users_list or outline_current_user_get.
outline_documents_archived_listList archived documents the user can access, optionally in one collection.Read-onlyList Archived Documents
List archived documents the user can access, optionally in one collection. Returns archived documents with id, title, archivedAt and deprecatedReason, plus pagination. Use outline_documents_archived_list to find archived content. Use outline_document_restore to bring one back.
Inputs
collection_idstring- UUID of a collection to limit the list to. Get it from outline_collections_list.
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
sortstring- Field to sort results by, such as updatedAt, createdAt, title or index. Example: updatedAt.
outline_documents_deleted_listList documents in the trash that the user can access.Read-onlyList Deleted Documents
List documents in the trash that the user can access. Trashed documents are permanently deleted after 30 days. Returns deleted documents with id, title, deletedAt and deletedBy, plus pagination. Use outline_documents_deleted_list to find something deleted by mistake. Use outline_document_restore to recover it.
Inputs
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC filtersarray- Advanced structured filters, combined with AND. Each entry is a condition with a field, an operator and usually a value, or a group with an operator of AND or OR and its own list of filters. Supported fields: deletedAt (date) and deletedById (user UUID, eq or in only). Operators include eq, neq, lt, lte, gt, gte, in, notIn, isNull and isNotNull. Date fields accept an ISO 8601 date or an ISO 8601 duration relative to now. Example: [{"field": "deletedAt", "operator": "gte", "value": "2026-01-01"}].
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
sortstring- Field to sort results by, such as updatedAt, createdAt, title or index. Example: updatedAt.
outline_documents_drafts_listList the connected user's draft (unpublished) documents.Read-onlyList Draft Documents
List the connected user's draft (unpublished) documents. Returns draft documents with id, title, text, collectionId and timestamps, plus pagination. Use outline_documents_drafts_list for unpublished work. Use outline_documents_list for published documents.
Inputs
collection_idstring- UUID of a collection to limit drafts to. Get it from outline_collections_list.
date_filterstring- Only return drafts updated within this period: day, week, month or year.one of
dayweekmonthyear directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
sortstring- Field to sort results by, such as updatedAt, createdAt, title or index. Example: updatedAt.
outline_documents_listList published documents and the user's own drafts, optionally limited to one collection or to the children of a parent document.Read-onlyList Documents
List published documents and the user's own drafts, optionally limited to one collection or to the children of a parent document. Returns a page of documents with id, urlId, title, text, collectionId, parentDocumentId, timestamps and url, plus pagination. Use outline_documents_list to browse documents. Use outline_documents_search for a keyword search of document content, or outline_documents_search_titles to match titles only.
Inputs
backlink_document_idstring- UUID of a document; only documents that link to it are listed. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
collection_idstring- UUID of a collection to limit the list to. Get it from outline_collections_list.
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC filtersarray- Advanced structured filters, combined with AND. Each entry is a condition with a field, an operator and usually a value, or a group with an operator of AND or OR and its own list of filters. Supported fields: createdAt, updatedAt, publishedAt, archivedAt, title, templateId, collectionId, userId, documentId and parentDocumentId. Operators include eq, neq, lt, lte, gt, gte, contains, startsWith, endsWith, in, notIn, isNull and isNotNull. Date fields accept an ISO 8601 date or an ISO 8601 duration relative to now. Example: [{"field": "updatedAt", "operator": "gte", "value": "2026-01-01"}].
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
parent_document_idstring- UUID of a parent document; only its direct children are listed. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
sortstring- Field to sort results by, such as updatedAt, createdAt, title or index. Example: updatedAt.
outline_documents_searchSearch the content of documents the user can access, by keyword, optionally within one collection.Read-onlySearch Documents
Search the content of documents the user can access, by keyword, optionally within one collection. Returns ranked results, each with a context snippet showing the match, a ranking score and the full document object, plus pagination. Use outline_documents_search to find documents by what they say. Use outline_documents_search_titles for a faster title-only match, or outline_documents_answer_question for an AI answer.
Inputs
querystringrequired- Keywords to search for in document titles and text. Supports quoted phrases. Example: hiring policy.
collection_idstring- UUID of a collection to search within. Get it from outline_collections_list.
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC filtersarray- Advanced structured filters, combined with AND. Each entry is a condition with a field, an operator and usually a value, or a group with an operator of AND or OR and its own list of filters. Supported fields: createdAt, updatedAt, publishedAt, archivedAt, title, templateId, collectionId, userId, documentId and parentDocumentId. Operators include eq, neq, lt, lte, gt, gte, contains, startsWith, endsWith, in, notIn, isNull and isNotNull. Date fields accept an ISO 8601 date or an ISO 8601 duration relative to now. Example: [{"field": "updatedAt", "operator": "gte", "value": "2026-01-01"}].
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
snippet_max_wordsinteger- Maximum number of words in each result's context snippet. Outline's default is 30.
snippet_min_wordsinteger- Minimum number of words in each result's context snippet. Outline's default is 20.
sortstring- Field to sort results by: createdAt, updatedAt or title. Leave empty to sort by relevance (best match first).one of
createdAtupdatedAttitle
outline_documents_search_titlesSearch document titles by keyword, optionally within one collection.Read-onlySearch Document Titles
Search document titles by keyword, optionally within one collection. Faster than a full-text search. Returns matching documents with id, urlId, title, collectionId, timestamps and url, plus pagination. Use outline_documents_search_titles when you know part of a title. Use outline_documents_search to match words inside documents.
Inputs
querystringrequired- Text to match against document titles. Example: onboarding.
collection_idstring- UUID of a collection to search within. Get it from outline_collections_list.
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC filtersarray- Advanced structured filters, combined with AND. Each entry is a condition with a field, an operator and usually a value, or a group with an operator of AND or OR and its own list of filters. Supported fields: createdAt, updatedAt, publishedAt, archivedAt, title, templateId, collectionId, userId, documentId and parentDocumentId. Operators include eq, neq, lt, lte, gt, gte, contains, startsWith, endsWith, in, notIn, isNull and isNotNull. Date fields accept an ISO 8601 date or an ISO 8601 duration relative to now. Example: [{"field": "updatedAt", "operator": "gte", "value": "2026-01-01"}].
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
sortstring- Field to sort results by: createdAt, updatedAt or title. Leave empty to sort by relevance (best match first).one of
createdAtupdatedAttitle
outline_documents_viewed_listList documents the connected user viewed recently.Read-onlyList Recently Viewed Documents
List documents the connected user viewed recently. Returns documents with id, title, collectionId and timestamps, plus pagination. Use outline_documents_viewed_list to pick up recent work. Use outline_views_list to see who viewed one document.
Inputs
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
sortstring- Field to sort results by. One of: updatedAt, createdAt.one of
updatedAtcreatedAt
outline_events_listList the activity trail of the workspace, such as documents created, published or moved, optionally filtered by event, user, document or collection.Read-onlyList Events
List the activity trail of the workspace, such as documents created, published or moved, optionally filtered by event, user, document or collection. Returns events with id, name, actorId, documentId, collectionId, data and createdAt, plus pagination. Use outline_events_list to see who did what. Set audit_log=true (admins only) for detailed audit events.
Inputs
actor_idstring- UUID of a user; only events they performed are returned. Get it from outline_users_list or outline_current_user_get.
audit_logboolean- Set to true for detailed events suitable for an audit log. Requires an admin.
collection_idstring- UUID of a collection; only events in it are returned. Get it from outline_collections_list.
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC document_idstring- UUID of a document; only events on it are returned. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
namestring- Only return this event type, written as objects.verb. Example: documents.publish.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
sortstring- Field to sort results by, such as updatedAt, createdAt, title or index. Example: updatedAt.
outline_file_operation_getGet the status of one import or export job.Read-onlyGet File Operation
Get the status of one import or export job. Returns the file operation's id, type, state (creating, uploading, complete, error or expired), size and timestamps. Use outline_file_operation_get to poll an export started with outline_collection_export until it is complete.
Inputs
idstringrequired- UUID of the file operation, from outline_collection_export or outline_file_operations_list.
outline_file_operations_listList import or export jobs in the workspace.Read-onlyList File Operations
List import or export jobs in the workspace. Returns file operations with id, type, state, format, size, collectionId and timestamps, plus pagination. Use outline_file_operations_list to find past exports. Use outline_file_operation_get to check one job.
Inputs
typestringrequired- Kind of job to list: export or import.one of
exportimport directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
sortstring- Field to sort results by, such as updatedAt, createdAt, title or index. Example: updatedAt.
outline_group_getGet one group by ID.Read-onlyGet Group
Get one group by ID. Returns the group's id, name, memberCount and timestamps. Use outline_group_get for a group's details. Use outline_group_memberships_list for its members.
Inputs
idstringrequired- UUID of the group. Get it from outline_groups_list.
outline_group_memberships_listList the members of a group, optionally filtered by name.Read-onlyList Group Members
List the members of a group, optionally filtered by name. Returns group memberships and the member users with id, name and email, plus pagination. Use outline_group_memberships_list to see who is in a group. Use outline_groups_list to find the group.
Inputs
idstringrequired- UUID of the group. Get it from outline_groups_list.
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
querystring- Text to filter results by user name. Example: jenny.
outline_groups_listList groups in the workspace, optionally only those a user belongs to or matching a name.Read-onlyList Groups
List groups in the workspace, optionally only those a user belongs to or matching a name. Returns groups with id, name, memberCount and timestamps, plus pagination. Use outline_groups_list to find a group ID. Use outline_group_memberships_list for a group's members.
Inputs
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC external_idstring- Only return the group with this external ID, as set by a directory sync. Example: 00g1abcd2EFGH3ijk4l5.
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
querystring- Text to match against group names. Example: engineering.
sortstring- Field to sort results by, such as updatedAt, createdAt, title or index. Example: updatedAt.
user_idstring- UUID of a user; only groups that include them are returned. Get it from outline_users_list or outline_current_user_get.
outline_notifications_listList the connected user's notifications, newest first, optionally by event type or archived state.Read-onlyList Notifications
List the connected user's notifications, newest first, optionally by event type or archived state. Returns notifications with id, event, actor, documentId, viewedAt, archivedAt and createdAt, plus pagination. Use outline_notifications_list to see what needs attention. Use outline_notification_update to mark one viewed or archived.
Inputs
archivedboolean- Set to true to return only archived notifications.
event_typestring- Only return notifications of this event type. Example: documents.mentioned.
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
outline_pins_listList documents pinned to a collection, or to the home screen when no collection is given.Read-onlyList Pinned Documents
List documents pinned to a collection, or to the home screen when no collection is given. Returns pins with id, documentId, collectionId and index, plus pagination. Use outline_pins_list to see highlighted documents. Use outline_pin_create to pin one.
Inputs
collection_idstring- UUID of a collection whose pins to list. Leave empty for home screen pins. Get it from outline_collections_list.
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
outline_revision_getGet one revision of a document, including its content at that point in time.Read-onlyGet Revision
Get one revision of a document, including its content at that point in time. Returns the revision's id, documentId, title, text, createdBy and createdAt. Use outline_revision_get to read an old version. Use outline_revisions_list to find revision IDs.
Inputs
idstringrequired- UUID of the revision. Get it from outline_revisions_list.
outline_revisions_listList the saved revisions (history) of a document, without their content.Read-onlyList Document Revisions
List the saved revisions (history) of a document, without their content. Returns revisions with id, title, createdBy and createdAt, plus pagination. Use outline_revisions_list to see a document's history. Use outline_revision_get for one revision's content, or outline_document_restore to roll back.
Inputs
document_idstringrequired- UUID of the document whose history to list. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
sortstring- Field to sort results by, such as updatedAt, createdAt, title or index. Example: updatedAt.
outline_stars_listList the documents and collections the connected user has starred.Read-onlyList Starred Items
List the documents and collections the connected user has starred. Returns stars with id, documentId or collectionId and index, plus the starred documents, plus pagination. Use outline_stars_list to see the user's bookmarks. Use outline_star_create to add one.
Inputs
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
outline_subscriptions_listList the connected user's subscription to a document or collection.Read-onlyList Subscriptions
List the connected user's subscription to a document or collection. Returns subscriptions with id, documentId or collectionId, event and createdAt, plus pagination. Use outline_subscriptions_list to check whether the user follows something. Use outline_subscription_create to follow it. Provide exactly one of document_id or collection_id.
Inputs
collection_idstring- UUID of a collection. Provide this or document_id. Get it from outline_collections_list.
document_idstring- UUID of a document. Provide this or collection_id. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
outline_template_getGet one template by ID, including its content.Read-onlyGet Template
Get one template by ID, including its content. Returns the template's id, title, content, collectionId and timestamps. Use outline_template_get to inspect a template. Use outline_document_create with template_id to start a document from it.
Inputs
idstringrequired- UUID or urlId of the template. Get it from outline_templates_list.
outline_templates_listList document templates available to the user, optionally in one collection or matching a title.Read-onlyList Templates
List document templates available to the user, optionally in one collection or matching a title. Returns templates with id, title, collectionId and timestamps, plus pagination. Use outline_templates_list to find a template ID for outline_document_create. Use outline_template_get for a template's content.
Inputs
collection_idstring- UUID of a collection to limit templates to. Get it from outline_collections_list.
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
querystring- Text to match against template titles. Example: meeting notes.
sortstring- Field to sort results by, such as updatedAt, createdAt, title or index. Example: updatedAt.
outline_user_getGet one user in the workspace by ID.Read-onlyGet User
Get one user in the workspace by ID. Returns the user's id, name, email, role, avatarUrl, lastActiveAt and timestamps. Use outline_user_get to look up a user you have an ID for. Use outline_users_list to search users.
Inputs
idstringrequired- UUID of the user. Get it from outline_users_list or outline_current_user_get.
outline_users_listList users in the Outline workspace, optionally filtered by name or email text or by role.Read-onlyList Users
List users in the Outline workspace, optionally filtered by name or email text or by role. Returns users with id, name, email, role, avatarUrl, lastActiveAt and timestamps, plus pagination. Use outline_users_list to find a user ID. Use outline_user_get for one user, or outline_current_user_get for the connected user.
Inputs
directionstring- Sort order: ASC (oldest or A first) or DESC (newest or Z first).one of
ASCDESC filtersarray- Advanced structured filters, combined with AND. Each entry is a condition with a field, an operator and usually a value, or a group with an operator of AND or OR and its own list of filters. Supported fields: id, name, email, role, createdAt, updatedAt, lastActiveAt and suspendedAt. Operators include eq, neq, lt, lte, gt, gte, contains, startsWith, endsWith, in, notIn, isNull and isNotNull. Date fields accept an ISO 8601 date or an ISO 8601 duration relative to now. Example: [{"field": "updatedAt", "operator": "gte", "value": "2026-01-01"}].
limitinteger- Maximum number of results to return in this page. Outline's default is 25; up to 100 per page. Example: 25.
offsetinteger- Number of results to skip, for paging. Use the previous offset plus limit to get the next page. Example: 25.
querystring- Text to match against user names and emails. Example: jane.
rolestring- Only return users with this role: admin, member, viewer or guest.one of
adminmemberviewerguest sortstring- Field to sort results by, such as updatedAt, createdAt, title or index. Example: updatedAt.
outline_views_listList the users who viewed a document and how many times.Read-onlyList Document Views
List the users who viewed a document and how many times. Returns views with the user, count, firstViewedAt and lastViewedAt. Use outline_views_list to see a document's readers. Use outline_documents_viewed_list for documents the connected user viewed.
Inputs
document_idstringrequired- UUID of the document. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
include_suspendedboolean- Set to true to include views from suspended users.
outline_attachment_create_from_urlStore a file from a public URL as an Outline attachment.WriteCreate Attachment from URL
Store a file from a public URL as an Outline attachment. Outline downloads the file itself. Returns the attachment with its id, name, size and url, ready to use at once. Use outline_attachment_create_from_url to add an image or file to Outline; then reference its url in a document's Markdown with outline_document_update.
Inputs
urlstringrequired- Public URL of the file to fetch. Example: https://example.com/diagram.png.
document_idstring- UUID of the document the attachment belongs to. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
outline_collection_archiveArchive a collection, hiding it and its documents from the sidebar and search until restored.WriteArchive Collection
Archive a collection, hiding it and its documents from the sidebar and search until restored. Returns the archived collection. Use outline_collection_archive to retire a collection. Use outline_collection_restore to undo it, or outline_collection_delete to remove it for good.
- Idempotent
Inputs
idstringrequired- UUID of the collection. Get it from outline_collections_list.
reasonstring- Optional reason for archiving, stored as deprecatedReason. Example: Project finished.
outline_collection_createCreate a new collection to organize documents.WriteCreate Collection
Create a new collection to organize documents. Returns the new collection with its id, name, description and permission. Use outline_collection_create for a new collection. Use outline_collection_update to change an existing one.
Inputs
namestringrequired- Name of the collection, up to 100 characters. Example: Human Resources.
colorstring- Hex color for the collection icon. Example: #123123.
descriptionstring- Short description of the collection in Markdown. Example: Policies and guides for the people team.
iconstring- Icon for the collection: an emoji or an outline-icons name. Example: 📚.
permissionstring- Default access for all workspace members: `read` (view only) or `read_write` (view and edit). Leave empty to make the collection private to members you add.one of
readread_write sharingboolean- Set to true to allow documents in this collection to be shared publicly.
outline_collection_duplicateCopy a collection with its published documents and settings.WriteDuplicate Collection
Copy a collection with its published documents and settings. Drafts and archived documents are not copied. Returns the new collection; documents are copied in the background, so it may fill in over a few moments. Use outline_collection_duplicate to clone a collection. Use outline_collection_create to start an empty one.
Inputs
idstringrequired- UUID of the collection to copy. Get it from outline_collections_list.
namestring- Name for the copy. Leave empty to reuse the original name. Example: Human Resources (copy).
outline_collection_exportStart an export of a whole collection, with its documents and attachments, as a zip file.WriteExport Collection
Start an export of a whole collection, with its documents and attachments, as a zip file. Returns a fileOperation with its id and state; the export runs in the background. Use outline_collection_export for a bulk export. Poll outline_file_operation_get with the returned fileOperation id until state is complete; the finished file can then be downloaded from Outline. Use outline_document_export for one document.
Inputs
idstringrequired- UUID of the collection. Get it from outline_collections_list.
formatstring- Export format: outline-markdown (Markdown files), json, html or okf.one of
outline-markdownjsonhtmlokf
outline_collection_group_addGive every member of a group access to a collection.WriteAdd Group to Collection
Give every member of a group access to a collection. Returns the new group membership. Use outline_collection_group_add to share a collection with a team. Use outline_collection_user_add for one person.
- Idempotent
Inputs
group_idstringrequired- UUID of the group to add. Get it from outline_groups_list.
idstringrequired- UUID of the collection. Get it from outline_collections_list.
permissionstring- Access level for the group's collection access: `read` (view only) or `read_write` (view and edit).one of
readread_write
outline_collection_restoreRestore an archived collection so it and its documents show in the sidebar and search again.WriteRestore Collection
Restore an archived collection so it and its documents show in the sidebar and search again. Returns the restored collection. Use outline_collection_restore to undo outline_collection_archive.
- Idempotent
Inputs
idstringrequired- UUID of the collection. Get it from outline_collections_list.
outline_collection_updateUpdate a collection's name, description, icon, color, default permission or sharing setting.WriteUpdate Collection
Update a collection's name, description, icon, color, default permission or sharing setting. Returns the updated collection. Use outline_collection_update to change collection settings. Use outline_collection_user_add or outline_collection_group_add to give specific people access.
- Idempotent
Inputs
idstringrequired- UUID of the collection. Get it from outline_collections_list.
colorstring- Hex color for the collection icon. Example: #4E5C6E.
descriptionstring- New description in Markdown. Example: Everything about hiring and benefits.
iconstring- New icon: an emoji or an outline-icons name. Example: 🧑🤝🧑.
namestring- New name for the collection. Example: People Team.
permissionstring- Default access for all workspace members: `read` or `read_write`.one of
readread_write sharingboolean- Set to true to allow public sharing of documents in this collection, false to disallow it.
outline_collection_user_addGive a user access to a collection.WriteAdd User to Collection
Give a user access to a collection. Returns the new membership and the user. Use outline_collection_user_add to share a collection with a person. Use outline_collection_group_add for a team, or outline_document_user_add for one document.
- Idempotent
Inputs
idstringrequired- UUID of the collection. Get it from outline_collections_list.
user_idstringrequired- UUID of the user to add. Get it from outline_users_list or outline_current_user_get.
permissionstring- Access level for the user's collection access: `read` (view only) or `read_write` (view and edit).one of
readread_write
outline_comment_createAdd a comment to a document, reply to a comment, or attach an inline comment to a passage of text.WriteCreate Comment
Add a comment to a document, reply to a comment, or attach an inline comment to a passage of text. Returns the new comment with its id and body. Use outline_comment_create to start or reply to a discussion. Use outline_comment_update to edit a comment.
Inputs
document_idstringrequired- UUID of the document to comment on. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
textstringrequired- Body of the comment in Markdown. Example: Looks good, but can we add a timeline?
anchor_prefixstring- Text just before anchor_text, to pick the right occurrence when it appears more than once. Needs anchor_text.
anchor_suffixstring- Text just after anchor_text, to pick the right occurrence when it appears more than once. Needs anchor_text.
anchor_textstring- Exact text in the document to attach an inline comment to. The first match is used unless anchor_prefix or anchor_suffix narrows it. Example: launch date.
parent_comment_idstring- UUID of the comment to reply to. Leave empty for a new top-level comment.
outline_comment_resolveMark a comment thread as resolved, hiding it from the document by default.WriteResolve Comment Thread
Mark a comment thread as resolved, hiding it from the document by default. Returns the resolved comment with resolvedAt and resolvedBy. Use outline_comment_resolve when a discussion is done. Use outline_comment_unresolve to reopen it.
- Idempotent
Inputs
idstringrequired- UUID of the comment. Get it from outline_comments_list.
outline_comment_unresolveReopen a resolved comment thread so it shows on the document again.WriteUnresolve Comment Thread
Reopen a resolved comment thread so it shows on the document again. Returns the comment. Use outline_comment_unresolve to undo outline_comment_resolve.
- Idempotent
Inputs
idstringrequired- UUID of the comment. Get it from outline_comments_list.
outline_comment_updateEdit the text of an existing comment.WriteUpdate Comment
Edit the text of an existing comment. Returns the updated comment. Use outline_comment_update to change what a comment says. Use outline_comment_resolve to close a thread instead.
- Idempotent
Inputs
idstringrequired- UUID of the comment. Get it from outline_comments_list.
textstringrequired- New body of the comment in Markdown. Example: Updated: timeline added below.
outline_document_archiveArchive a document, hiding it from the sidebar while keeping it searchable and restorable.WriteArchive Document
Archive a document, hiding it from the sidebar while keeping it searchable and restorable. Returns the archived document with its archivedAt time. Use outline_document_archive to retire outdated content. Use outline_document_restore to bring it back, or outline_document_delete to move it to the trash.
- Idempotent
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
reasonstring- Optional reason for archiving, stored on the document as deprecatedReason. Example: Replaced by the 2026 handbook.
outline_document_createCreate a new Outline document with Markdown text, as a draft or published in a collection or under a parent document.WriteCreate Document
Create a new Outline document with Markdown text, as a draft or published in a collection or under a parent document. Returns the new document with its id, urlId, title, text and url. Use outline_document_create for a new document. Use outline_document_update to change an existing one, or outline_document_duplicate to copy one. To publish, pass publish=true with collection_id or parent_document_id (get IDs from outline_collections_list or outline_documents_list).
Inputs
collection_idstring- UUID of the collection to create the document in. Needed to publish unless parent_document_id is set. Get it from outline_collections_list.
colorstring- Hex color for the document icon. Example: #FF5733.
full_widthboolean- Set to true to display the document in full width.
iconstring- Icon shown next to the title: an emoji or an outline-icons name. Example: 🚀.
parent_document_idstring- UUID of a parent document to nest the new document under. Needed to publish unless collection_id is set. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
publishboolean- Set to true to publish the document immediately so other workspace members can see it. Leave empty or false to create a draft. Publishing needs collection_id or parent_document_id.
template_idstring- UUID of a template to base the document on. Get it from outline_templates_list.
textstring- Body of the document in Markdown. Example: # Goals\n- Ship the new onboarding flow.
titlestring- Title of the new document, up to 100 characters. Example: Q3 Planning.
outline_document_duplicateCopy a document, optionally with all of its child documents, into the same or another location.WriteDuplicate Document
Copy a document, optionally with all of its child documents, into the same or another location. Returns the new documents. Use outline_document_duplicate to copy existing content. Use outline_document_create to start from scratch, or outline_document_templatize to make a reusable template.
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
collection_idstring- UUID of the collection to copy the document into. Get it from outline_collections_list.
parent_document_idstring- UUID of the parent document to copy the document under. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
publishboolean- Set to true to publish the copy; otherwise it is created as a draft.
recursiveboolean- Set to true to also copy every child document.
titlestring- Title for the copy. Leave empty to reuse the original title. Example: Q3 Planning (copy).
outline_document_group_addGive every member of a group access to a document.WriteAdd Group to Document
Give every member of a group access to a document. Returns the new group membership. Use outline_document_group_add to share a document with a team. Use outline_document_user_add for one person.
- Idempotent
Inputs
group_idstringrequired- UUID of the group to add. Get it from outline_groups_list.
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
permissionstring- Access level for the group's document access: `read` (view only) or `read_write` (view and edit).one of
readread_write
outline_document_moveMove a document to another collection, under another parent document, or to a new position.WriteMove Document
Move a document to another collection, under another parent document, or to a new position. Returns the moved documents and the affected collections. Use outline_document_move to change where a document lives. Use outline_document_update to change its content. With no parent_document_id, the document moves to the root of the collection.
- Idempotent
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
collection_idstring- UUID of the collection to move the document into. Get it from outline_collections_list.
indexinteger- Zero-based position among its new siblings. Example: 0 puts it first.
parent_document_idstring- UUID of the new parent document. Leave empty to move to the collection root. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
outline_document_restoreRestore an archived or deleted document, or roll a document back to an earlier revision.WriteRestore Document
Restore an archived or deleted document, or roll a document back to an earlier revision. Returns the restored document. Use outline_document_restore to undo outline_document_archive or outline_document_delete. Use outline_revisions_list to find a revision ID to roll back to.
- Idempotent
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
collection_idstring- UUID of the collection to restore the document into, if its original collection is gone. Get it from outline_collections_list.
revision_idstring- UUID of a revision to restore the document to. Get it from outline_revisions_list.
outline_document_templatizeCreate a new template from an existing document's content.WriteCreate Template from Document
Create a new template from an existing document's content. Returns the new template with its id and title. Use outline_document_templatize to reuse a document as a starting point. Use outline_templates_list to see existing templates.
Inputs
idstringrequired- UUID of the document to turn into a template. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
publishbooleanrequired- Set to true to make the template available to other members; false keeps it as a draft only you can see.
collection_idstring- UUID of the collection the template belongs to. Leave empty for a workspace-wide template. Get it from outline_collections_list.
outline_document_unpublishUnpublish a document, turning it back into a draft and removing it from its collection.WriteUnpublish Document
Unpublish a document, turning it back into a draft and removing it from its collection. Returns the document, now a draft. Use outline_document_unpublish to take a page out of circulation while keeping it editable. Use outline_document_archive to keep it searchable but hidden.
- Idempotent
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
detachboolean- Set to true to also detach the draft from its collection.
outline_document_updateUpdate an Outline document's title or text, or publish a draft.WriteUpdate Document
Update an Outline document's title or text, or publish a draft. Text can replace the body, be appended or prepended, or replace one passage. Returns the updated document with its id, title, text, revision number and url. Use outline_document_update to edit content. Use outline_document_move to change its location, or outline_document_archive to retire it.
- Idempotent
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
colorstring- Hex color for the document icon. Example: #4E5C6E.
edit_modestring- How text is applied: `replace` the body, `append` to the end, `prepend` to the start, or `patch` to replace the first occurrence of find_text with text.one of
appendprependreplacepatch find_textstring- Existing text to replace with `text`. Required when edit_mode is `patch`. Example: Status: draft.
full_widthboolean- Set to true to display the document in full width, false for normal width.
iconstring- New icon: an emoji or an outline-icons name. Example: 📘.
last_revisioninteger- Revision number you last read (the `revision` field of the document). If the document has changed since, Outline rejects the update with 409 instead of overwriting. Example: 12.
publishboolean- Set to true to publish the document if it is still a draft.
textstring- Markdown text to write. How it is applied depends on edit_mode; by default it replaces the whole body. Example: ## Update\nShipped on time.
titlestring- New title for the document. Example: Q3 Planning (final).
outline_document_user_addGive a user direct access to a document.WriteAdd User to Document
Give a user direct access to a document. Returns the new membership and the user. Use outline_document_user_add to share one document with a person. Use outline_collection_user_add for a whole collection, or outline_document_group_add for a group.
- Idempotent
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
user_idstringrequired- UUID of the user to add. Get it from outline_users_list or outline_current_user_get.
permissionstring- Access level for the user's document access: `read` (view only) or `read_write` (view and edit).one of
readread_write
outline_notification_updateMark a notification as viewed or archived by setting the matching timestamp.WriteUpdate Notification
Mark a notification as viewed or archived by setting the matching timestamp. Returns the updated notification. Use outline_notification_update to clear a notification. Get the ID from outline_notifications_list.
- Idempotent
Inputs
idstringrequired- UUID of the notification. Get it from outline_notifications_list.
archived_atstring- When the notification was archived, as an ISO 8601 date-time. Set it to archive the notification. Example: 2026-10-14T09:00:00Z.
viewed_atstring- When the notification was viewed, as an ISO 8601 date-time. Set it to mark the notification viewed. Example: 2026-10-14T09:00:00Z.
outline_pin_createPin a document to the top of a collection, or to the home screen.WritePin Document
Pin a document to the top of a collection, or to the home screen. Pins are visible to every workspace member. Returns the new pin with its id. Use outline_pin_create to highlight a document for everyone. Use outline_star_create for a personal bookmark.
Inputs
document_idstringrequired- UUID of the document to pin. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
collection_idstring- UUID of the collection to pin the document in. Leave empty to pin to the home screen. Get it from outline_collections_list.
outline_star_createStar a document or collection so it appears in the user's sidebar.WriteStar Document or Collection
Star a document or collection so it appears in the user's sidebar. Returns the new star with its id. Use outline_star_create to bookmark something. Use outline_star_delete to remove a star. Provide document_id or collection_id.
Inputs
collection_idstring- UUID of the collection to star. Provide this or document_id. Get it from outline_collections_list.
document_idstring- UUID of the document to star. Provide this or collection_id. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
outline_subscription_createSubscribe the connected user to a document or collection so they get notified when it changes.WriteSubscribe to Document or Collection
Subscribe the connected user to a document or collection so they get notified when it changes. Returns the new subscription with its id. Use outline_subscription_create to follow changes. Use outline_subscription_delete to stop. Provide exactly one of document_id or collection_id.
Inputs
collection_idstring- UUID of the collection to follow. Provide this or document_id. Get it from outline_collections_list.
document_idstring- UUID of the document to follow. Provide this or collection_id. Use the `id` field returned by outline_document_get or outline_documents_list (a UUID, not the short urlId).
outline_collection_deleteDelete a collection and every document in it.DestructiveDelete Collection
Delete a collection and every document in it. This cannot be undone. Returns success: true. Use outline_collection_delete only to remove a collection for good. Use outline_collection_archive to hide it and keep the option to restore.
- Idempotent
Inputs
idstringrequired- UUID of the collection. Get it from outline_collections_list.
reasonstring- Optional reason for the deletion, stored as deprecatedReason. Example: Team disbanded.
outline_collection_group_removeRevoke a group's access to a collection.DestructiveRemove Group from Collection
Revoke a group's access to a collection. Returns success: true. Use outline_collection_group_remove to stop sharing a collection with a team. Members may keep access through other memberships.
- Idempotent
Inputs
group_idstringrequired- UUID of the group to remove. Get it from outline_groups_list.
idstringrequired- UUID of the collection. Get it from outline_collections_list.
outline_collection_user_removeRemove a user's individual membership from a collection.DestructiveRemove User from Collection
Remove a user's individual membership from a collection. Returns success: true. Use outline_collection_user_remove to revoke direct access. The user may keep access through a group or the collection's default permission.
- Idempotent
Inputs
idstringrequired- UUID of the collection. Get it from outline_collections_list.
user_idstringrequired- UUID of the user to remove. Get it from outline_users_list or outline_current_user_get.
outline_comment_deleteDelete a comment.DestructiveDelete Comment
Delete a comment. Deleting a top-level comment also deletes its replies. Returns success: true. Use outline_comment_delete to remove a comment. Use outline_comment_resolve to close a thread but keep it.
- Idempotent
Inputs
idstringrequired- UUID of the comment. Get it from outline_comments_list.
outline_document_deleteDelete a document by moving it to the trash, where it can be restored for 30 days, or delete it permanently.DestructiveDelete Document
Delete a document by moving it to the trash, where it can be restored for 30 days, or delete it permanently. Returns success: true. Use outline_document_delete to remove a document. Use outline_document_archive to hide it without deleting, and outline_document_restore to undo a delete.
- Idempotent
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
permanentboolean- Set to true to destroy the document immediately with no way to recover it, instead of moving it to the trash.
reasonstring- Optional reason for the deletion, stored as deprecatedReason. Example: Duplicate of the onboarding guide.
outline_document_group_removeRevoke a group's access to a document.DestructiveRemove Group from Document
Revoke a group's access to a document. Returns success: true. Use outline_document_group_remove to stop sharing a document with a team. Members may keep access through other memberships.
- Idempotent
Inputs
group_idstringrequired- UUID of the group to remove. Get it from outline_groups_list.
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
outline_document_user_removeRemove a user's direct membership from a document.DestructiveRemove User from Document
Remove a user's direct membership from a document. Returns success: true. Use outline_document_user_remove to revoke direct access. The user may keep access through the collection or a group; check with outline_document_users_list.
- Idempotent
Inputs
idstringrequired- ID of the document. Accepts the document UUID or its urlId, the short code at the end of the document URL (for https://acme.getoutline.com/doc/welcome-hDYep1TPAM it is hDYep1TPAM). Get it from outline_documents_list or outline_documents_search.
user_idstringrequired- UUID of the user to remove. Get it from outline_users_list or outline_current_user_get.
outline_pin_deleteRemove a pin.DestructiveUnpin Document
Remove a pin. The document itself is not affected. Returns success: true. Use outline_pin_delete to unpin. Get the pin ID from outline_pins_list.
- Idempotent
Inputs
idstringrequired- UUID of the pin (not the document). Get it from outline_pins_list.
outline_star_deleteRemove a star from the user's sidebar.DestructiveRemove Star
Remove a star from the user's sidebar. The document or collection is not affected. Returns success: true. Use outline_star_delete to unstar. Get the star ID from outline_stars_list.
- Idempotent
Inputs
idstringrequired- UUID of the star (not the document). Get it from outline_stars_list.
outline_subscription_deleteUnsubscribe the connected user from a document or collection.DestructiveUnsubscribe
Unsubscribe the connected user from a document or collection. Returns success: true. Use outline_subscription_delete to stop notifications. Get the subscription ID from outline_subscriptions_list.
- Idempotent
Inputs
idstringrequired- UUID of the subscription. Get it from outline_subscriptions_list.
No tools match.
