Skip to main content
Outline logo
  • Category: productivity
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 101
  • Triggers: 0
  • Slug: OUTLINE
  • Version: 20261101_00

Tools

Slug: OUTLINE_ACTIVATE_USERTool to activate a previously suspended user in Outline. Activating a user allows them to sign in again and will cause billing totals to be re-calculated in the hosted version. Use when you need to restore access for a suspended user.

Input Parameters

string
required
Unique identifier for the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_ADD_COLLECTION_GROUPTool to add a group to a collection in Outline. Use when you need to grant all members of a group access to a specific collection with read or write permissions.

Input Parameters

string
required
Collection ID (UUID). The unique identifier of the collection to which the group will be added.
string
required
Group ID (UUID). The unique identifier of the group to add to the collection.
string
Permission level to grant to the group. Common values are ‘read’ for read-only access and ‘read_write’ for read and write access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_ADD_DOCUMENT_USERTool to add a user membership to a document. Use when you need to grant a user access to a specific document.

Input Parameters

string
required
Document identifier. Either the UUID or the urlId is acceptable.
string
required
User ID of the user to add to the document
string
Permission level for the user being added to the document. If not specified, the default permission will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_ADD_GROUP_TO_DOCUMENTTool to give all members in a group access to a document. Use when you need to grant document-level access permissions to an entire group at once, rather than adding individual users one by one.

Input Parameters

string
required
Unique identifier for the document. Either the UUID or the urlId is acceptable.
string
required
Unique identifier (UUID) for the group to add to the document.
string ("read" | "read_write")
Permission levels for document access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_ADD_GROUP_USERTool to add a user to a group. Use when you need to grant a user membership in a specific group.

Input Parameters

string
required
Identifier for the group
string
required
Identifier for the user to add to the group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_ADD_USER_TO_COLLECTIONTool to add a user to a collection with specified permissions. Use when you need to grant a user access to a specific collection.

Input Parameters

string
required
Identifier for the collection
string
required
Identifier for the user to add to the collection
string
Permission level for the user in the collection (e.g., ‘read’, ‘read_write’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_ARCHIVE_DOCUMENTTool to archive a document in Outline. Use when you need to move outdated information out of sight while retaining the ability to search and restore it later.

Input Parameters

string
required
Unique identifier for the document. Either the UUID or the urlId is acceptable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_CREATE_ATTACHMENTTool to create an attachment in Outline. This creates a database record and returns the inputs needed to generate a signed URL and upload the file from the client to cloud storage. Use when you need to prepare an attachment for upload to associate with a document.

Input Parameters

string
required
Name of the file attachment
integer
required
Size of the file attachment in bytes
string
Identifier for the associated document, if any
string
required
MIME type of the file attachment (e.g., ‘application/pdf’, ‘image/png’, ‘text/plain’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_CREATE_COLLECTIONTool to create a new collection in Outline. Use when you need to organize documents by creating a new collection with a specific name, description, icon, color, and permission settings.

Input Parameters

string
A string that represents an icon in the outline-icons package or an emoji
string
required
Name of the collection to create
string
A hex color code for the collection icon
boolean
Whether public sharing of documents is allowed in this collection
string ("read" | "read_write")
Permission level for collection access.
string
A brief description of the collection, markdown supported

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_CREATE_COMMENTTool to create a comment on an Outline document. Use when you need to add a comment or reply to a document. Either text or data field is required for the comment body.

Input Parameters

string
Optional comment identifier. If not provided, one will be generated automatically.
object
The body of the comment as structured data. Either text or data is required.
string
The body of the comment in markdown format. Either text or data is required.
string
required
The unique identifier of the document to comment on
string
Parent comment ID for replies. Specify this to create a threaded reply to an existing comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_CREATE_DOCUMENTTool to create a new document in Outline. Use when you need to create a new document with specified title, content, and metadata. Documents can be created as drafts or immediately published to a collection. At least one of collectionId or parentDocumentId is required if publish is true.

Input Parameters

string
Optional identifier for the document (UUID format)
string
Icon displayed alongside the document title (emoji or icon name)
string
The body of the document in markdown format
string
Color for the document icon in hex format (e.g., #FF0000)
string
Document title. If not provided, a default title will be generated
boolean
Whether this document should be immediately published and made visible to other workspace members. Requires collectionId or parentDocumentId
string
Optionally set the created date in the past (ISO 8601 date-time format)
boolean
Whether the document should be displayed in full width mode
string
Template ID (UUID format) to use for creating the document
string
Identifier for the collection (UUID format). Required to publish unless parentDocumentId is provided
array
Custom data attributes to be included on the document
string
Identifier for the parent document (UUID format). Required to publish unless collectionId is provided. Used to nest documents

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_CREATE_GROUPTool to create a new group in Outline. Use when you need to organize users into logical groups for easier permission management across collections.

Input Parameters

string
required
The name of the group to create. Groups are used to organize users and assign collection permissions to multiple users at once.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_CREATE_O_AUTH_CLIENTTool to create a new OAuth client in Outline. Use when you need to create an OAuth client application that can be used to authenticate users and access the API on their behalf.

Input Parameters

string
required
Name of the OAuth client
string
A URL pointing to an image representing the OAuth client
boolean
Whether the OAuth client is available to other workspaces
string
A short description of this OAuth client
string
The URL of the developer who created this OAuth client
array
required
List of redirect URIs for the OAuth client. These URIs are used for OAuth callbacks after authentication
string
The name of the developer who created this OAuth client

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_CREATE_SHARETool to create a public share link for an Outline document. Use when you need to generate a shareable URL that allows access without workspace membership. If you request multiple shares for the same document with the same API key, the same share object will be returned.

Input Parameters

string
Optional password protection for the share. Users must enter this password to access the shared document
string
Expiration timestamp for the share link (ISO 8601 date-time format). If not provided, the share link will not expire
string
required
The unique identifier of the document to share (UUID format)
boolean
Whether child documents should be included in the share. If true, shared access includes nested documents

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_CREATE_STARTool to create a star for a document or collection in Outline. Use when you need to star (favorite) a document or collection so it appears in the user’s sidebar. One of either documentId or collectionId must be provided.

Input Parameters

string
Index of the star in the list of stars. Used to control the position of the star in the sidebar.
string
The unique identifier (UUID) of the document to star. Either documentId or collectionId must be provided.
string
The unique identifier (UUID) of the collection to star. Either documentId or collectionId must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_CREATE_TEMPLATETool to create a new template in Outline. Use when you need to create a reusable template that can be used as a starting point for new documents. Templates can optionally be scoped to a specific collection.

Input Parameters

string
Optionally provide a specific UUID for the template
object
required
The body of the template as a Prosemirror document. Must be a valid Prosemirror JSON structure with type, content, and other required fields.
string
An emoji to use as the template icon
string
The color of the template icon in hex format
string
required
The title of the template
string
Identifier for the collection to which the template belongs. Templates can optionally be scoped to a specific collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_CREATE_VIEWTool to create a view for a document. Use when you need to record that a document has been viewed. Note: It is recommended that views are not created from outside of the Outline UI.

Input Parameters

string
required
The unique identifier of the document to create a view for. This must be a valid UUID of an existing document in the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_DELETE_ATTACHMENTTool to delete an attachment from Outline. Deleting an attachment is permanent. It will not delete references or links to the attachment that may exist in your documents.

Input Parameters

string
required
Unique identifier for the attachment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_DELETE_COLLECTIONTool to delete a collection and all of its documents from Outline. Use when you need to permanently remove a collection. This action cannot be undone, so use with caution.

Input Parameters

string
required
The unique identifier (UUID) of the collection to delete. All documents within the collection will also be permanently deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_DELETE_COMMENTTool to delete a comment in Outline. Use when you need to remove a comment from a document. If the comment is a top-level comment, all its children will be deleted as well.

Input Parameters

string
required
The unique identifier for the comment to delete. If the comment is a top-level comment, all its children will be deleted as well.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_DELETE_DOCUMENTTool to delete a document in Outline. Deleting a document moves it to the trash by default. If not restored within 30 days it is permanently deleted. Use permanent=true to destroy the document immediately with no way to recover.

Input Parameters

string
required
Unique identifier for the document. Either the UUID or the urlId is acceptable.
boolean
If set to true the document will be destroyed with no way to recover rather than moved to the trash.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_DELETE_FILE_OPERATIONTool to delete a file operation and its associated files from Outline. Use when you need to clean up completed or failed import/export operations.

Input Parameters

string
required
Unique identifier for the file operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_DELETE_GROUPTool to delete a group from Outline. Deleting a group will cause all of its members to lose access to any collections the group has previously been added to. This action cannot be undone, so use with caution.

Input Parameters

string
required
The unique identifier (UUID) of the group to delete. Deleting a group will cause all of its members to lose access to any collections the group has previously been added to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_DELETE_OAUTH_AUTHENTICATIONTool to delete an OAuth authentication in Outline. Use when you need to revoke a third-party application’s access to a user’s account. This action removes the OAuth authentication connection between Outline and the third-party application.

Input Parameters

array
Optional array of permission scopes to delete. If not provided, all scopes will be deleted.
string
required
The unique identifier (UUID) of the OAuth client whose authentication should be deleted. This will revoke the third-party application’s access to the user’s account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_DELETE_OAUTH_CLIENTTool to delete an OAuth client from Outline. Permanently delete an OAuth client and revoke all associated access tokens. This action cannot be undone, so use with caution.

Input Parameters

string
required
Unique identifier for the OAuth client to delete. Deleting an OAuth client will permanently revoke all associated access tokens. This action cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_DELETE_STARTool to delete a star from a document in Outline. Use when you need to remove a star from a user’s starred documents list.

Input Parameters

string
required
The unique identifier (UUID) of the star to delete. Removes the star from the document, removing it from the user’s starred documents list in the sidebar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_DELETE_TEMPLATETool to delete a template in Outline. This will soft-delete the template, it can be restored later. Use when you need to remove a template from the workspace.

Input Parameters

string
required
Unique identifier for the template. Either the UUID or the urlId is acceptable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_DELETE_USERTool to delete a user in Outline. Deleting a user removes the object entirely. In almost every circumstance it is preferable to suspend a user, as a deleted user can be recreated by signing in with SSO again. Use when you need to permanently remove a user from the workspace.

Input Parameters

string
required
Unique identifier for the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_DUPLICATE_DOCUMENTTool to duplicate an Outline document. Use when you need to create a copy of an existing document, optionally including all child documents in the hierarchy.

Input Parameters

string
required
Unique identifier for the document. Either the UUID or the urlId is acceptable.
string
New title for the duplicated document. If not provided, the title of the original document will be used.
boolean
Whether the new document should be published. If false or not specified, the document will maintain the same publish state as the original.
boolean
Whether child documents should also be duplicated. Set to true to duplicate the entire document tree.
string
Identifier for the collection the document should be copied to. If not provided, the document will be duplicated in the same collection as the original.
string
Identifier for the parent document the document should be copied to. If not provided, the document will be duplicated at the same level in the hierarchy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_DUPLICATE_TEMPLATETool to duplicate an Outline template. Use when you need to create a copy of an existing template, optionally with a new title or in a different collection.

Input Parameters

string
required
Unique identifier for the template to duplicate. Either the UUID or the urlId is acceptable.
string
Override the title of the duplicated template. If not provided, the title of the original template will be used.
string
Identifier for the collection to place the duplicated template in. If not provided, uses the original template’s collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_EMPTY_DOCUMENTS_TRASHTool to permanently delete all documents in the trash. Use when you need to empty the trash and remove all trashed documents permanently. WARNING: This action is irreversible and only available to admin users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_EXPORT_ALL_COLLECTIONSTool to export all collections and their documents in bulk. Use when you need to create a backup or export of all workspace collections. Returns a FileOperation object for tracking export progress.

Input Parameters

string ("outline-markdown" | "json" | "html")
Export format. Options: ‘outline-markdown’ (default), ‘json’, or ‘html’
boolean
Whether to include private collections in the export
boolean
Whether to include attachments in the export

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_EXPORT_COLLECTIONTool to export a collection in markdown, JSON, or HTML format. Triggers a bulk export that includes all documents and attachments. If documents are nested, they will be organized in folders within the zip file. Returns a fileOperation object to track progress.

Input Parameters

string
required
The unique identifier (UUID) of the collection to export.
string ("outline-markdown" | "json" | "html")
Format options for collection export.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_EXPORT_DOCUMENTExport an Outline document as a downloadable file, optionally including child documents. The request can specify paper size and signed URL duration.

Input Parameters

string
required
Unique identifier for the document. Either the UUID or the urlId is acceptable.
string
Paper size for PDF export. Common values: A4, Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A5, A6. Only applicable when Accept header is application/pdf.
integer
How long signed URLs should remain valid for attachment links (in seconds). Useful for controlling access to embedded images and attachments in the exported document.
boolean
Whether to include child documents in the export. Using this option will always return a zip file containing the parent document and all its children.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_ATTACHMENT_REDIRECTTool to retrieve an attachment redirect URL from Outline. Loads an attachment from where it is stored based on the id. If the attachment is private, a temporary signed URL with embedded credentials is generated on demand. Use when you need to access or download an attachment.

Input Parameters

string
required
Unique identifier for the attachment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_AUTH_CONFIGTool to retrieve authentication configuration options for an Outline workspace. Use when you need to discover the workspace name, hostname, or available SSO/OAuth authentication services before user login.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_COLLECTIONTool to retrieve a collection by its unique identifier. Use when you need to fetch detailed information about a specific collection including its name, description, settings, and permissions.

Input Parameters

string
required
Unique identifier for the collection (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_COLLECTION_DOCUMENTSRetrieve a collection’s document structure as a tree of navigation nodes. The returned tree is limited to five levels of nesting.

Input Parameters

string
required
Unique identifier for the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_COMMENTTool to retrieve a comment by its ID from Outline. Use when you need to fetch detailed information about a specific comment including its content, author, timestamps, and resolution status.

Input Parameters

string
required
Comment ID to retrieve
boolean
Include the document text that the comment is anchored to, if any, in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_DOCUMENT_INFOTool to retrieve a document from Outline by its UUID, urlId, or shareId. Returns complete document information including title, content, metadata, timestamps, and access policies. Use when you need to fetch document details or content.

Input Parameters

string
Unique identifier for the document. Either the UUID or the urlId is acceptable. At least one of id or shareId must be provided.
string
Unique identifier for a document share. A shareId may be used in place of a document UUID. At least one of id or shareId must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_DOCUMENTS_DOCUMENTSTool to retrieve a document’s child structure. Returns the nested document tree (hierarchy) for the children of the specified document. Use when you need to explore document organization or navigate the document hierarchy.

Input Parameters

string
required
Unique identifier for the document. Either the UUID or the urlId is acceptable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_FILE_OPERATION_INFOTool to retrieve the details and current status of a file operation by its unique identifier. Use when you need to check the progress of import or export operations.

Input Parameters

string
required
Unique identifier for the file operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_GROUP_INFOTool to retrieve a group by its unique identifier. Returns group details including name and member count. Use when you need to fetch information about a specific group.

Input Parameters

string
required
Unique identifier for the group (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_OAUTH_CLIENT_INFORetrieve an Outline OAuth client by its ID or clientId. The response can include configuration details such as name, scopes, and redirect URIs.

Input Parameters

string
Unique identifier for the OAuth client. At least one of id or clientId must be provided.
string
Public identifier for the OAuth client. At least one of id or clientId must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_REVISION_INFOTool to retrieve a revision by its ID from Outline. A revision is a snapshot of a document at a specific point in time. Use when you need to fetch historical document content or view editing history.

Input Parameters

string
required
Unique identifier for the revision.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_SHARE_INFORetrieve an Outline share by share ID or associated document ID. The response includes share details such as URL and visibility settings, and may include policies and view statistics.

Input Parameters

string
Unique identifier for the share. At least one of id or documentId must be provided.
string
Unique identifier for a document. Retrieves the share for this document. At least one of id or documentId must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_TEMPLATE_INFOTool to retrieve a template by its unique identifier. Use when you need to fetch detailed information about a specific template including its title, content, and metadata.

Input Parameters

string
required
Unique identifier for the template. Either the UUID or the urlId is acceptable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_GET_USER_INFOTool to retrieve a user by their unique identifier. Returns user details including name, email, avatar, role, and status. Use when you need to fetch information about a specific user.

Input Parameters

string
required
Unique identifier for the user (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_INVITE_USERSTool to invite users to the Outline workspace. Use when you need to send email invitations to one or more users to join the workspace.

Input Parameters

array
required
Array of user invitations containing email, name, and role for each user to invite

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_ARCHIVED_DOCUMENTSList all archived documents in the Outline workspace. Returns paginated archived documents that the current user has access to, with metadata and authorization policies. Use limit and offset for pagination through large result sets.

Input Parameters

integer
Maximum number of archived documents to return per request (default: 25, max: 100). Use for pagination to control result set size.
integer
Number of documents to skip before returning results (default: 0). Use with limit to paginate through archived documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_COLLECTION_GROUP_MEMBERSHIPSList a page of group memberships for a specific Outline collection, including group details and membership permissions. Use limit and offset to paginate, and optionally filter by group name or permission.

Input Parameters

string
required
Identifier for the collection (UUID format). This is the collection whose group memberships you want to retrieve.
integer
Maximum number of results to return per page. Use with offset for pagination.
string
Search query to filter memberships by group names. Returns only groups whose names match the query string.
integer
Number of results to skip before returning data. Use with limit for pagination (e.g., offset=50 with limit=50 gets results 51-100).
string
Filter memberships by permission level (e.g., ‘read’, ‘read_write’). Returns only memberships with the specified permission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_COLLECTION_MEMBERSHIPSTool to list all individual user memberships for a collection. Use when you need to see who has access to a specific collection and their permission levels. Note: This only returns individual user memberships, not group memberships.

Input Parameters

string
required
Unique identifier for the collection to list memberships for.
integer
Maximum number of results to return per page.
string
Filter memberships by user names. Search string to match against user names.
integer
Number of results to skip for pagination.
string
Filter memberships by permission level (e.g., read, write, admin).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_COLLECTIONSTool to list all collections that the authenticated user has access to. Use when you need to retrieve all collections, optionally filtered by name or status, with pagination and sorting support.

Input Parameters

string
Field to sort collections by (e.g., ‘name’, ‘updatedAt’, ‘createdAt’)
integer
Maximum number of collections to return per page
string
Search query to filter collections by name
integer
Number of collections to skip for pagination
string ("ASC" | "DESC")
Sort direction for collections.
array
Filter collections by status (e.g., archived). Omit to include all statuses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_COMMENTSList comments for a required document, optionally filtering by collection. Supports pagination and sorting and returns comment data including content, authors, timestamps, and resolution status.

Input Parameters

string
Field name to sort comments by (e.g., ‘createdAt’, ‘updatedAt’). Determines the ordering of results.
integer
Maximum number of comments to return. Use for pagination to control response size.
integer
Number of comments to skip. Use with limit for pagination through large result sets.
string ("ASC" | "DESC")
Sort direction enum.
string
required
UUID of the document to filter comments for. Required to list comments associated with a specific document.
string
Filter comments to a specific collection by its UUID. Returns only comments from documents in this collection.
boolean
When true, includes the document text that the comment is anchored to in the response. Useful for providing context around inline comments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_DATA_ATTRIBUTESTool to list all data attributes in Outline. Use when you need to retrieve custom data attributes that can be attached to documents for structured metadata.

Input Parameters

string
Field name to sort results by (e.g., ‘name’, ‘updatedAt’, ‘createdAt’).
integer
Maximum number of data attributes to return in a single request. Default is typically 25.
integer
Number of results to skip for pagination. Use with limit to paginate through results.
string ("ASC" | "DESC")
Sort direction for listing data attributes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_DELETED_DOCUMENTSTool to list all deleted documents in the workspace that the current user has access to. Use when you need to retrieve, review, or restore documents that have been deleted. Supports pagination and sorting to efficiently navigate through large numbers of deleted documents.

Input Parameters

string
Field name to sort the results by (e.g., ‘updatedAt’, ‘createdAt’, ‘title’). Controls the ordering of returned documents.
integer
Number of deleted documents to return per page. Use to control response size for pagination.
integer
Pagination offset - number of documents to skip. Use with limit to navigate through pages of results.
string
Sort direction for the results. Use ‘ASC’ for ascending order or ‘DESC’ for descending order. Only applicable when sort field is specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_DOCUMENT_GROUP_MEMBERSHIPSTool to list a document’s group memberships. Use when you need to see which groups have access to a specific document and their permission levels.

Input Parameters

string
required
The document identifier (UUID or urlId format)
integer
Maximum number of results to return for pagination
string
Filter results by group names
integer
Number of results to skip for pagination
string
Filter by permission level (e.g., ‘read’, ‘read_write’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_DOCUMENT_MEMBERSHIPSTool to list users with direct membership to a document. Use when you need to see who has direct access to a specific document and their permission levels. Note: This returns only users with direct memberships. To list all users with access to a document (including through group memberships), use documents.users instead.

Input Parameters

string
required
Unique identifier for the document. Either the UUID or the urlId is acceptable.
integer
Maximum number of results to return. Use for pagination to control response size.
string
Filter results by user name. Search string to match against user names.
integer
Number of results to skip. Use with limit for pagination through large result sets.
string ("read" | "read_write")
Permission levels for document access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_DOCUMENTSTool to list all documents in your Outline workspace. Returns published documents and draft documents belonging to the current user. Use filters to narrow results by collection, creator, status, or document relationships. Supports pagination for large document sets.

Input Parameters

string
Field name to sort results by. Common values include ‘title’, ‘createdAt’, ‘updatedAt’. Defaults to the API’s default sorting.
integer
Maximum number of documents to return per page. Use for pagination to control result set size.
integer
Number of documents to skip before starting to return results. Use with limit for pagination (e.g., offset=50 with limit=25 returns items 51-75).
string
Unique identifier of the user to filter documents by creator. Only documents created by this user will be returned. Useful for viewing documents authored by a specific person.
string
Sort direction: ‘ASC’ for ascending or ‘DESC’ for descending. Only applies when sort parameter is provided.
string
Unique identifier of the collection to filter documents by. Only documents belonging to this collection will be returned. Useful for viewing all documents within a specific collection.
array
Filter documents by status. Accepts an array with one or more of: ‘draft’, ‘archived’, or ‘published’. When omitted, returns both published documents and drafts belonging to the current user.
string
Unique identifier of a parent document. Returns child documents (sub-pages) of this parent document. Useful for navigating document hierarchies.
Unique identifier of a document. Returns documents that contain backlinks to this document. Useful for finding all documents that reference a specific document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_DOCUMENT_USERSTool to list all users with access to a document. Returns all users who have any level of access to the specified document. Use when you need to see who can view or edit a document.

Input Parameters

string
required
Unique identifier for the document. Either the UUID or the urlId is acceptable.
integer
Maximum number of results to return. Use for pagination to control response size.
string
If set, will filter the results by user name.
integer
Number of results to skip. Use with limit for pagination through large result sets.
string
If set, will filter the results to a specific user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_DRAFT_DOCUMENTSTool to list all draft documents belonging to the current user. Use when you need to retrieve unpublished documents. Supports filtering by collection, date recency, pagination, and sorting.

Input Parameters

string
Field name to sort by (e.g., ‘title’, ‘updatedAt’, ‘createdAt’).
integer
Maximum number of results per page. Must be >= 1.
integer
Starting position for results (pagination offset). Must be >= 0.
string ("ASC" | "DESC")
Sort direction.
string ("day" | "week" | "month" | "year")
Date filter for documents by update recency.
string
Filter documents by collection UUID. Only returns drafts within the specified collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_EVENTSTool to list all events from the audit trail. Use when you need to track actions taken in the knowledge base, such as document creation, permission changes, or user activity. Events provide a comprehensive audit trail for compliance and monitoring.

Input Parameters

string
Filter to a specific event type (e.g., ‘collections.create’, ‘documents.update’, ‘users.signin’). Use this to track specific types of actions in the knowledge base.
string
Field name to sort events by (e.g., ‘createdAt’). Determines the ordering of results.
integer
Maximum number of events to return per page. Use for pagination to control response size.
integer
Number of events to skip before starting to return results. Use with limit for pagination through large result sets.
string
Filter events to those performed by a specific user. Provide the user’s UUID to see all actions taken by that user.
boolean
When true, returns detailed events suitable for audit logging purposes. Use this to get comprehensive event information for compliance or security reviews.
string ("ASC" | "DESC")
Sort direction enum.
string
Filter events to those related to a specific document. Provide the document’s UUID to see its complete history.
string
Filter events to those related to a specific collection. Provide the collection’s UUID to track all activities within that collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_FILE_OPERATIONSList file operations for the workspace, optionally filtered by import or export type. Results are paginated and can be used to monitor progress and retrieve available download URLs.

Input Parameters

string ("export" | "import")
File operation type options.
integer
Maximum number of file operations to return per page. Use for pagination to control result set size.
integer
Number of file operations to skip before starting to return results. Use with limit for pagination (e.g., offset=25 with limit=25 returns items 26-50).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_GROUP_MEMBERSHIPSList members of a specific Outline group, returning user details and membership relationships. Supports name queries and pagination.

Input Parameters

string
required
Identifier for the group (UUID format). This is the group whose members you want to retrieve.
integer
Maximum number of results to return per page. Use with offset for pagination.
string
Search query to filter memberships by user names. Returns only users whose names match the query string.
integer
Number of results to skip before returning data. Use with limit for pagination (e.g., offset=50 with limit=50 gets results 51-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_GROUPSTool to list all groups in the workspace. Groups organize users and manage permissions for collections. Use when you need to retrieve all groups, optionally filtered by name, with pagination and sorting support.

Input Parameters

string
Field to sort groups by (e.g., ‘name’, ‘updatedAt’, ‘createdAt’)
integer
Maximum number of groups to return per page
string
Search query to filter groups by name
integer
Number of groups to skip for pagination
string ("ASC" | "DESC")
Sort direction for groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_O_AUTH_AUTHENTICATIONSTool to list all OAuth authentications for the current user. Use when you need to see which third-party applications have been authorized to access the user’s account.

Input Parameters

integer
Maximum number of OAuth authentications to return per page
integer
Number of OAuth authentications to skip for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_OAUTH_CLIENTSTool to list all OAuth clients accessible to the authenticated user. Use when you need to retrieve OAuth clients for third-party integrations. Returns both clients created by the user and published clients available to the workspace.

Input Parameters

integer
Maximum number of OAuth clients to return per page. Use for pagination to control response size.
integer
Number of OAuth clients to skip. Use with limit for pagination through large result sets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_RECENTLY_VIEWED_DOCUMENTSTool to list all recently viewed documents by the current user. Returns documents ordered by when they were last viewed. Supports pagination and sorting for large result sets.

Input Parameters

string
Field name to sort results by. Common values include ‘title’, ‘createdAt’, ‘updatedAt’, ‘viewedAt’. Defaults to the API’s default sorting.
integer
Maximum number of documents to return per page. Use for pagination to control result set size.
integer
Number of documents to skip before starting to return results. Use with limit for pagination (e.g., offset=50 with limit=25 returns items 51-75).
string
Sort direction: ‘ASC’ for ascending or ‘DESC’ for descending. Only applies when sort parameter is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_REVISIONSTool to list all revisions for a specific document. Revisions represent historical snapshots of document content and are useful for tracking changes over time. Use when you need to view a document’s editing history or restore to a previous version.

Input Parameters

string
Field name to sort revisions by (e.g., ‘createdAt’). Determines the ordering of results.
integer
Maximum number of revisions to return per page. Use for pagination to control response size.
integer
Number of revisions to skip before starting to return results. Use with limit for pagination through large result sets.
string ("ASC" | "DESC")
Sort direction enum.
string
required
Unique identifier of the document to retrieve revisions for. This is required to specify which document’s revision history you want to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_SHARESTool to list all share links in the workspace. Use when you need to retrieve all public document shares, optionally filtered by search query, with pagination and sorting support.

Input Parameters

string
Field to sort shares by (e.g., ‘updatedAt’, ‘createdAt’)
integer
Maximum number of shares to return per page
string
Filter to shared documents matching a search query
integer
Number of shares to skip for pagination
string ("ASC" | "DESC")
Sort direction for shares.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_STARSTool to list all starred documents and collections for the authenticated user. Use when you need to retrieve bookmarked items that users have marked for quick access in their sidebar.

Input Parameters

string
Field name to sort stars by (e.g., ‘createdAt’). Determines the ordering of results.
integer
Maximum number of starred items to return per page. Use for pagination to control response size.
integer
Number of starred items to skip before starting to return results. Use with limit for pagination through large result sets.
string
Filter starred items to those created by a specific user. Provide the user’s UUID to see their bookmarked documents and collections.
string ("ASC" | "DESC")
Sort direction enum.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_TEMPLATESTool to list all templates available to the current user. Use when you need to retrieve all templates, optionally filtered by collection or name, with pagination and sorting support. Templates not associated with a collection are workspace-wide.

Input Parameters

string
Field to sort templates by (e.g., ‘title’, ‘createdAt’, ‘updatedAt’)
integer
Maximum number of templates to return per page
string
Search query to filter templates by name
integer
Number of templates to skip for pagination
string ("ASC" | "DESC")
Sort direction for templates.
string
Filter templates to a specific collection by its UUID. Templates not associated with a collection are workspace-wide.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_USERSTool to list all users in the workspace. Use when you need to retrieve all users, optionally filtered by name, email, or status, with pagination and sorting support.

Input Parameters

string
Field to sort users by (e.g., ‘name’, ‘email’, ‘createdAt’, ‘updatedAt’, ‘lastActiveAt’)
integer
Maximum number of users to return per page
string
Search query to filter users by name or email
string ("active" | "invited" | "suspended")
Filter users by status.
integer
Number of users to skip for pagination
string ("ASC" | "DESC")
Sort direction for users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_LIST_VIEWSList view records for a specific document, including viewer information, first and last view timestamps, and per-user view counts. Supports pagination and an option to include suspended users.

Input Parameters

integer
Maximum number of results to return. Use for pagination to control response size.
integer
Number of results to skip. Use with limit for pagination through large result sets.
string
required
Unique identifier of the document to retrieve views for. Returns all users who have viewed this document and the total view count.
boolean
Whether to include views from suspended users in the results. If true, views from suspended users will be included; if false or omitted, only active users are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_MOVE_DOCUMENTTool to move a document to a new location or collection in Outline. Use when you need to reorganize documents by moving them to a different collection or nesting them under a different parent document.

Input Parameters

string
required
Unique identifier for the document. Either the UUID or the urlId is acceptable.
number
The position index in the collection structure. Used to specify the order of the document within its parent or collection.
string
Collection ID to move the document to. If not provided along with parentDocumentId, the document retains its current collection.
string
Parent document ID to nest the document under. If not provided, the document will be moved to the collection root.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_REDIRECT_FILE_OPERATIONRetrieve the redirect URL for an Outline file operation by ID, for accessing or downloading the resulting file.

Input Parameters

string
required
Unique identifier for the file operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_REMOVE_COLLECTION_GROUPTool to remove a group from a collection, revoking access for all group members. Use when you need to remove group-level access to a collection. Note that members may retain access through other groups or individual memberships.

Input Parameters

string
required
Identifier for the collection
string
required
Group ID to remove from the collection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_REMOVE_COLLECTION_USERTool to remove a user from a collection. Use when you need to revoke a user’s access to a specific collection in Outline.

Input Parameters

string
required
Identifier for the collection from which the user will be removed
string
required
Identifier for the user to remove from the collection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_REMOVE_DOCUMENT_USERTool to remove a user membership from a document. Use when you need to revoke a user’s access to a specific document.

Input Parameters

string
required
Document identifier. Either the UUID or the urlId is acceptable.
string
required
User ID of the user to remove from the document

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_REMOVE_GROUP_FROM_DOCUMENTTool to remove a group from a document, revoking access for all group members. Use when you need to revoke document-level access for an entire group at once.

Input Parameters

string
required
Unique identifier for the document. Either the UUID or the urlId is acceptable.
string
required
Unique identifier (UUID) for the group to remove from the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_REMOVE_GROUP_USERTool to remove a user from a group. Use when you need to revoke a user’s group membership in Outline.

Input Parameters

string
required
Identifier for the group from which the user will be removed
string
required
Identifier for the user to remove from the group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_RESTORE_DOCUMENTTool to restore a document in Outline. If a document has been archived or deleted, it can be restored. Optionally a revision can be passed to restore the document to a previous point in time.

Input Parameters

string
required
Unique identifier for the document. Either the UUID or the urlId is acceptable.
string
Identifier for the revision to restore to. If provided, the document will be restored to a previous point in time.
string
Identifier for the collection to restore the document to. If not provided, the document will be restored to its original collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_RESTORE_TEMPLATETool to restore a previously deleted template in Outline. Use when you need to recover a template that was soft-deleted.

Input Parameters

string
required
Unique identifier for the template. Either the UUID or the urlId is acceptable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_RETRIEVE_AUTH_INFOTool to retrieve authentication details for the current API key. Use when you need to verify that an API token is valid or obtain identifying information for the authenticated user and workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_REVOKE_SHARETool to revoke a share in Outline, making the share link inactive so it can no longer be used to access the document. Use when you need to disable public access to a shared document.

Input Parameters

string
required
Unique identifier (UUID) of the share to revoke. Once revoked, the share link will become inactive and can no longer be used to access the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_ROTATE_OAUTH_CLIENT_SECRETTool to rotate the secret for an OAuth client in Outline. Use when you need to generate a new client secret for an OAuth client. The old secret will be invalidated immediately.

Input Parameters

string
required
Unique identifier for the OAuth client. Rotating the secret will generate a new client secret and invalidate the old one immediately.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_SEARCH_DOCUMENTSTool to search all documents in your Outline workspace using keywords. Results are restricted to documents accessible by the current access token. Use filters to narrow results by collection, user, status, or timeframe. Supports sorting by relevance, date, or title.

Input Parameters

string
Field name to sort results by. Accepted values: ‘relevance’ (default, best match first), ‘createdAt’, ‘updatedAt’, or ‘title’.
integer
Maximum number of documents to return per page. Use for pagination to control result set size.
string
required
Search keywords to find matching documents. Use natural language search terms. Required parameter.
integer
Number of documents to skip before starting to return results. Use with limit for pagination (e.g., offset=50 with limit=25 returns items 51-75).
string
Unique identifier of the user. Filters documents edited by this specific user. Useful for finding documents modified by a team member.
string
Filters search by collection or document referenced via share ID. Use this when working with shared document links.
string
Sort direction: ‘ASC’ for ascending or ‘DESC’ for descending. Only applies when sort parameter is provided.
string
Limits results to documents within specified timeframe. Accepted values: ‘day’ (last 24 hours), ‘week’ (last 7 days), ‘month’ (last 30 days), or ‘year’ (last 365 days).
string
Unique identifier of a document. Searches within this document and all its children (sub-pages). Useful for searching within a specific document hierarchy.
string
Unique identifier of the collection. Restricts search to documents within this particular collection only.
array
Filter documents by status. Accepts an array with one or more of: ‘draft’, ‘archived’, or ‘published’. When omitted, searches across all statuses accessible to the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_SEARCH_DOCUMENT_TITLESTool to search document titles in Outline workspace using keywords. Unlike full document search, this searches only titles and returns faster results. Use when you need to quickly find documents by their title. Supports filters for collection, creator, status, and date range.

Input Parameters

string ("relevance" | "createdAt" | "updatedAt" | "title")
Sort field options for search results.
integer
Maximum number of documents to return per page. Use for pagination to control result set size.
string
required
Search query to match against document titles. This searches only titles, not content, for faster results.
integer
Number of documents to skip before starting to return results. Use with limit for pagination (e.g., offset=50 with limit=25 returns items 51-75).
string
Filter results by document creator. Only documents created by this user will be returned.
string
Filter results for the collection or document referenced by the shareId. Useful for searching within shared content.
string ("ASC" | "DESC")
Sort direction options.
string ("day" | "week" | "month" | "year")
Date filter period values.
string
Filter results to content within a specific document and its children. Useful for searching within a document hierarchy.
string
Filter results to a specific collection by its UUID. Only documents within this collection will be returned.
array
Filter documents by status. Accepts an array with one or more of: draft, archived, or published. When omitted, returns published documents and drafts belonging to the current user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_SUSPEND_USERTool to suspend a user in Outline. Suspending a user prevents them from signing in and they are not counted against billing totals. Use when you need to temporarily disable a user’s access without deleting their account.

Input Parameters

string
required
Unique identifier for the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_TEMPLATIZE_DOCUMENTTool to create a template from an existing Outline document. Use when you need to convert a document into a reusable template for your workspace.

Input Parameters

string
required
Unique identifier for the document to convert into a template. Either the UUID or the urlId is acceptable.
boolean
required
Whether the new template should be published. Set to true to make the template immediately available to workspace members.
string
Identifier for the collection where the template should be created. If not provided, the template will be created in the same collection as the source document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_UNPUBLISH_DOCUMENTUnpublish an Outline document to return it to draft status. Optionally detach it from the collection structure when unpublishing.

Input Parameters

string
required
Unique identifier for the document. Either the UUID or the urlId is acceptable.
boolean
Whether to detach the document from the collection. If true, the document will be removed from the collection structure when unpublished.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_UPDATE_COLLECTIONTool to update an existing collection’s properties in Outline. Use when you need to modify collection settings such as name, description, icon, color, sharing settings, or permission level.

Input Parameters

string
required
The unique identifier of the collection to update
string
A string that represents an icon in the outline-icons package or an emoji
string
New name for the collection
string
A hex color code for the collection icon
boolean
Whether public sharing of documents is allowed
string
Permission level for the collection (read/write)
string
New description for the collection, markdown supported

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_UPDATE_COMMENTTool to update a comment in Outline. Use when you need to modify the content of an existing comment. The comment body should be provided in ProseMirror document format with type and content fields.

Input Parameters

string
required
The unique identifier for the comment to update (UUID format).
object
required
The comment body content in ProseMirror document format. Should include ‘type’ (typically ‘doc’) and ‘content’ array with paragraph objects containing text nodes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_UPDATE_DOCUMENTTool to update a document in Outline. Use when you need to modify an existing document’s title, content, or metadata. At least the document ID is required.

Input Parameters

string
required
Unique identifier for the document. Either the UUID or the urlId is acceptable.
string
Icon displayed alongside the document title
string
The body of the document in markdown.
string
Color for the document icon in hex format
string
The title of the document.
boolean
Whether this document should be published and made visible to other workspace members, if a draft
string
Edit mode
boolean
Whether the document should be displayed in full width
string
Identifier for the template this document is based on
string
Identifier for the collection to move the document to
array
Data attributes to be updated. Attributes not included will be removed from the document.
boolean
Whether insights should be visible on the document

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_UPDATE_GROUPTool to update an existing group’s name in Outline. Use when you need to rename a group.

Input Parameters

string
required
Group ID (UUID). The unique identifier of the group to update.
string
required
New name for the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_UPDATE_O_AUTH_CLIENTTool to update an existing OAuth client in Outline. Use when you need to modify an OAuth client’s properties such as name, description, redirect URIs, or published status.

Input Parameters

string
required
Unique identifier for the OAuth client to update
string
Name of the OAuth client
string
A URL pointing to an image representing the OAuth client
boolean
Whether the OAuth client is available to other workspaces
string
A short description of this OAuth client
string
The URL of the developer who created this OAuth client
array
List of redirect URIs for the OAuth client. These URIs are used for OAuth callbacks after authentication
string
The name of the developer who created this OAuth client

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_UPDATE_SHARETool to update a share in Outline. Use when you need to change a share’s published status, which controls whether authentication is required to access the shared link.

Input Parameters

string
required
The unique identifier for the share to update (UUID format).
boolean
required
Published status. When true, removes authentication and makes the share available to anyone with the link. When false, authentication is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_UPDATE_STARTool to update a star’s position in the Outline sidebar. Use when you need to reorder a user’s starred documents or collections by changing the display index.

Input Parameters

string
required
The unique identifier (UUID) of the star to update. This determines which starred item’s position will be changed in the sidebar.
string
required
The new position index for the star in the sidebar. Determines the display order relative to other starred documents. Lower numbers appear higher in the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_UPDATE_TEMPLATETool to update an existing template in Outline. Use when you need to modify a template’s title, content, icon, color, or other properties. At least the template ID is required.

Input Parameters

string
required
Unique identifier for the template. Either the UUID or the urlId is acceptable.
object
The body of the template as a Prosemirror document. Must be a valid Prosemirror JSON structure with type, content, and other required fields.
string
An emoji to use as the template icon.
string
The color of the template icon in hex format.
string
The title of the template.
boolean
Whether the template should be displayed full width.
string
Identifier for the collection to which the template belongs. Set to null for a workspace-wide template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_UPDATE_USERTool to update a user’s name, avatar, or language preference in Outline. If no ID is provided, updates the authenticated user. Use when you need to modify user profile information.

Input Parameters

string
Unique identifier for the user to update. If not provided, updates the authenticated user.
string
User name to update.
string
Language preference for the user.
string
URL to the user’s avatar image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLINE_UPDATE_USER_ROLETool to change a user’s role in Outline workspace. Use when you need to promote a user to admin, demote an admin to member, or change a user to viewer role. Only available to admin users.

Input Parameters

string
required
Unique identifier for the user whose role you want to change (UUID format).
string ("admin" | "member" | "viewer" | "guest")
required
New role to assign to the user. Admin: full permissions. Member: standard workspace access. Viewer: read-only access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not