Outline

outline

Team knowledge base and wiki for managing documentation and collaboration

Productivity Web del proveedor

Acciones

101

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (101)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Activate UserOUTLINE_ACTIVATE_USERAcción

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

Parámetros de entrada

idstringObligatorio
Unique identifier for the user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Group to CollectionOUTLINE_ADD_COLLECTION_GROUPAcción

Tool to add a group to a collection in Outline. Use when you need to grant all members of a group access to a specific collection with read or write permissions.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Document UserOUTLINE_ADD_DOCUMENT_USERAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Group to DocumentOUTLINE_ADD_GROUP_TO_DOCUMENTAcción

Tool to give all members in a group access to a document. Use when you need to grant document-level access permissions to an entire group at once, rather than adding individual users one by one.

Parámetros de entrada

idstringObligatorio
Unique identifier for the document. Either the UUID or the urlId is acceptable.
groupIdstringObligatorio
Unique identifier (UUID) for the group to add to the document.
permissionstringenum
Permission levels for document access.
readread_write

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add User to GroupOUTLINE_ADD_GROUP_USERAcción

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

Parámetros de entrada

idstringObligatorio
Identifier for the group
userIdstringObligatorio
Identifier for the user to add to the group

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add User to CollectionOUTLINE_ADD_USER_TO_COLLECTIONAcción

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

Parámetros de entrada

idstringObligatorio
Identifier for the collection
userIdstringObligatorio
Identifier for the user to add to the collection
permissionstring
Permission level for the user in the collection (e.g., 'read', 'read_write')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive DocumentOUTLINE_ARCHIVE_DOCUMENTAcción

Tool to archive a document in Outline. Use when you need to move outdated information out of sight while retaining the ability to search and restore it later.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create AttachmentOUTLINE_CREATE_ATTACHMENTAcción

Tool to create an attachment in Outline. This creates a database record and returns the inputs needed to generate a signed URL and upload the file from the client to cloud storage. Use when you need to prepare an attachment for upload to associate with a document.

Parámetros de entrada

namestringObligatorio
Name of the file attachment
sizeintegerObligatorio
Size of the file attachment in bytes
documentIdstring
Identifier for the associated document, if any
contentTypestringObligatorio
MIME type of the file attachment (e.g., 'application/pdf', 'image/png', 'text/plain')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create CollectionOUTLINE_CREATE_COLLECTIONAcción

Tool to create a new collection in Outline. Use when you need to organize documents by creating a new collection with a specific name, description, icon, color, and permission settings.

Parámetros de entrada

iconstring
A string that represents an icon in the outline-icons package or an emoji
namestringObligatorio
Name of the collection to create
colorstring
A hex color code for the collection icon
sharingboolean
Whether public sharing of documents is allowed in this collection
permissionstringenum
Permission level for collection access.
readread_write
descriptionstring
A brief description of the collection, markdown supported

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create CommentOUTLINE_CREATE_COMMENTAcción

Tool to create a comment on an Outline document. Use when you need to add a comment or reply to a document. Either text or data field is required for the comment body.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create DocumentOUTLINE_CREATE_DOCUMENTAcción

Tool to create a new document in Outline. Use when you need to create a new document with specified title, content, and metadata. Documents can be created as drafts or immediately published to a collection. At least one of collectionId or parentDocumentId is required if publish is true.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create GroupOUTLINE_CREATE_GROUPAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create OAuth ClientOUTLINE_CREATE_O_AUTH_CLIENTAcción

Tool to create a new OAuth client in Outline. Use when you need to create an OAuth client application that can be used to authenticate users and access the API on their behalf.

Parámetros de entrada

namestringObligatorio
Name of the OAuth client
avatarUrlstring
A URL pointing to an image representing the OAuth client
publishedboolean
Whether the OAuth client is available to other workspaces
descriptionstring
A short description of this OAuth client
developerUrlstring
The URL of the developer who created this OAuth client
redirectUrisstring[]Obligatorio
List of redirect URIs for the OAuth client. These URIs are used for OAuth callbacks after authentication
developerNamestring
The name of the developer who created this OAuth client

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ShareOUTLINE_CREATE_SHAREAcción

Tool to create a public share link for an Outline document. Use when you need to generate a shareable URL that allows access without workspace membership. If you request multiple shares for the same document with the same API key, the same share object will be returned.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create StarOUTLINE_CREATE_STARAcción

Tool to create a star for a document or collection in Outline. Use when you need to star (favorite) a document or collection so it appears in the user's sidebar. One of either documentId or collectionId must be provided.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create TemplateOUTLINE_CREATE_TEMPLATEAcción

Tool to create a new template in Outline. Use when you need to create a reusable template that can be used as a starting point for new documents. Templates can optionally be scoped to a specific collection.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ViewOUTLINE_CREATE_VIEWAcción

Tool to create a view for a document. Use when you need to record that a document has been viewed. Note: It is recommended that views are not created from outside of the Outline UI.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete AttachmentOUTLINE_DELETE_ATTACHMENTAcción

Tool to delete an attachment from Outline. Deleting an attachment is permanent. It will not delete references or links to the attachment that may exist in your documents.

Parámetros de entrada

idstringObligatorio
Unique identifier for the attachment.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete CollectionOUTLINE_DELETE_COLLECTIONAcción

Tool to delete a collection and all of its documents from Outline. Use when you need to permanently remove a collection. This action cannot be undone, so use with caution.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete CommentOUTLINE_DELETE_COMMENTAcción

Tool to delete a comment in Outline. Use when you need to remove a comment from a document. If the comment is a top-level comment, all its children will be deleted as well.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete DocumentOUTLINE_DELETE_DOCUMENTAcción

Tool to delete a document in Outline. Deleting a document moves it to the trash by default. If not restored within 30 days it is permanently deleted. Use permanent=true to destroy the document immediately with no way to recover.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete File OperationOUTLINE_DELETE_FILE_OPERATIONAcción

Tool to delete a file operation and its associated files from Outline. Use when you need to clean up completed or failed import/export operations.

Parámetros de entrada

idstringObligatorio
Unique identifier for the file operation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete GroupOUTLINE_DELETE_GROUPAcción

Tool to delete a group from Outline. Deleting a group will cause all of its members to lose access to any collections the group has previously been added to. This action cannot be undone, so use with caution.

Parámetros de entrada

idstringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete OAuth AuthenticationOUTLINE_DELETE_OAUTH_AUTHENTICATIONAcción

Tool to delete an OAuth authentication in Outline. Use when you need to revoke a third-party application's access to a user's account. This action removes the OAuth authentication connection between Outline and the third-party application.

Parámetros de entrada

scopestring[]
Optional array of permission scopes to delete. If not provided, all scopes will be deleted.
oauthClientIdstringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete OAuth ClientOUTLINE_DELETE_OAUTH_CLIENTAcción

Tool to delete an OAuth client from Outline. Permanently delete an OAuth client and revoke all associated access tokens. This action cannot be undone, so use with caution.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete StarOUTLINE_DELETE_STARAcción

Tool to delete a star from a document in Outline. Use when you need to remove a star from a user's starred documents list.

Parámetros de entrada

idstringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete TemplateOUTLINE_DELETE_TEMPLATEAcción

Tool to delete a template in Outline. This will soft-delete the template, it can be restored later. Use when you need to remove a template from the workspace.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete UserOUTLINE_DELETE_USERAcción

Tool to delete a user in Outline. Deleting a user removes the object entirely. In almost every circumstance it is preferable to suspend a user, as a deleted user can be recreated by signing in with SSO again. Use when you need to permanently remove a user from the workspace.

Parámetros de entrada

idstringObligatorio
Unique identifier for the user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Duplicate DocumentOUTLINE_DUPLICATE_DOCUMENTAcción

Tool to duplicate an Outline document. Use when you need to create a copy of an existing document, optionally including all child documents in the hierarchy.

Parámetros de entrada

idstringObligatorio
Unique identifier for the document. Either the UUID or the urlId is acceptable.
titlestring
New title for the duplicated document. If not provided, the title of the original document will be used.
publishboolean
Whether the new document should be published. If false or not specified, the document will maintain the same publish state as the original.
recursiveboolean
Whether child documents should also be duplicated. Set to true to duplicate the entire document tree.
collectionIdstring
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.
parentDocumentIdstring
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Duplicate TemplateOUTLINE_DUPLICATE_TEMPLATEAcción

Tool to duplicate an Outline template. Use when you need to create a copy of an existing template, optionally with a new title or in a different collection.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Empty Documents TrashOUTLINE_EMPTY_DOCUMENTS_TRASHAcción

Tool to permanently delete all documents in the trash. Use when you need to empty the trash and remove all trashed documents permanently. WARNING: This action is irreversible and only available to admin users.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Export All CollectionsOUTLINE_EXPORT_ALL_COLLECTIONSAcción

Tool to export all collections and their documents in bulk. Use when you need to create a backup or export of all workspace collections. Returns a FileOperation object for tracking export progress.

Parámetros de entrada

formatstringenum
Export format. Options: 'outline-markdown' (default), 'json', or 'html'
outline-markdownjsonhtml
includePrivateboolean
Whether to include private collections in the export
includeAttachmentsboolean
Whether to include attachments in the export

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Export CollectionOUTLINE_EXPORT_COLLECTIONAcción

Tool to export a collection in markdown, JSON, or HTML format. Triggers a bulk export that includes all documents and attachments. If documents are nested, they will be organized in folders within the zip file. Returns a fileOperation object to track progress.

Parámetros de entrada

idstringObligatorio
The unique identifier (UUID) of the collection to export.
formatstringenum
Format options for collection export.
outline-markdownjsonhtml

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Export DocumentOUTLINE_EXPORT_DOCUMENTAcción

Tool to export a document from Outline in Markdown, HTML, or PDF format. The response format is determined by the Accept header (text/markdown, text/html, or application/pdf). Use when you need to download or extract document content for external processing, archiving, or sharing.

Parámetros de entrada

idstringObligatorio
Unique identifier for the document. Either the UUID or the urlId is acceptable.
paper_sizestring
Paper size for PDF export. Common values: A4, Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A5, A6. Only applicable when Accept header is application/pdf.
signed_urlsinteger
How long signed URLs should remain valid for attachment links (in seconds). Useful for controlling access to embedded images and attachments in the exported document.
include_child_documentsboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Attachment Redirect URLOUTLINE_GET_ATTACHMENT_REDIRECTAcción

Tool to retrieve an attachment redirect URL from Outline. Loads an attachment from where it is stored based on the id. If the attachment is private, a temporary signed URL with embedded credentials is generated on demand. Use when you need to access or download an attachment.

Parámetros de entrada

idstringObligatorio
Unique identifier for the attachment.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get authentication configOUTLINE_GET_AUTH_CONFIGAcción

Tool to retrieve authentication configuration options for an Outline workspace. Use when you need to discover the workspace name, hostname, or available SSO/OAuth authentication services before user login.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection InfoOUTLINE_GET_COLLECTIONAcción

Tool to retrieve a collection by its unique identifier. Use when you need to fetch detailed information about a specific collection including its name, description, settings, and permissions.

Parámetros de entrada

idstringObligatorio
Unique identifier for the collection (UUID format).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection DocumentsOUTLINE_GET_COLLECTION_DOCUMENTSAcción

Tool to retrieve a collection's document structure as a tree of navigation nodes. Use when you need to explore the document hierarchy within a collection.

Parámetros de entrada

idstringObligatorio
Unique identifier for the collection.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CommentOUTLINE_GET_COMMENTAcción

Tool to retrieve a comment by its ID from Outline. Use when you need to fetch detailed information about a specific comment including its content, author, timestamps, and resolution status.

Parámetros de entrada

idstringObligatorio
Comment ID to retrieve
includeAnchorTextboolean
Include the document text that the comment is anchored to, if any, in the response.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Document InfoOUTLINE_GET_DOCUMENT_INFOAcción

Tool to retrieve a document from Outline by its UUID, urlId, or shareId. Returns complete document information including title, content, metadata, timestamps, and access policies. Use when you need to fetch document details or content.

Parámetros de entrada

idstring
Unique identifier for the document. Either the UUID or the urlId is acceptable. At least one of id or shareId must be provided.
shareIdstring
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Document Children StructureOUTLINE_GET_DOCUMENTS_DOCUMENTSAcción

Tool to retrieve a document's child structure. Returns the nested document tree (hierarchy) for the children of the specified document. Use when you need to explore document organization or navigate the document hierarchy.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get File Operation InfoOUTLINE_GET_FILE_OPERATION_INFOAcción

Tool to retrieve the details and current status of a file operation by its unique identifier. Use when you need to check the progress of import or export operations.

Parámetros de entrada

idstringObligatorio
Unique identifier for the file operation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Group InfoOUTLINE_GET_GROUP_INFOAcción

Tool to retrieve a group by its unique identifier. Returns group details including name and member count. Use when you need to fetch information about a specific group.

Parámetros de entrada

idstringObligatorio
Unique identifier for the group (UUID format).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get OAuth Client InfoOUTLINE_GET_OAUTH_CLIENT_INFOAcción

Tool to retrieve an OAuth client from Outline by its id or clientId. Returns complete OAuth client configuration including name, scopes, and redirect URIs. Use when you need to fetch OAuth client details.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Revision InfoOUTLINE_GET_REVISION_INFOAcción

Tool to retrieve a revision by its ID from Outline. A revision is a snapshot of a document at a specific point in time. Use when you need to fetch historical document content or view editing history.

Parámetros de entrada

idstringObligatorio
Unique identifier for the revision.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Share InfoOUTLINE_GET_SHARE_INFOAcción

Tool to retrieve a share object by its unique identifier or by the associated document ID. Returns complete share information including URL, visibility settings, access permissions, and view statistics. Use when you need to fetch details about a shared document.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Template InfoOUTLINE_GET_TEMPLATE_INFOAcción

Tool to retrieve a template by its unique identifier. Use when you need to fetch detailed information about a specific template including its title, content, and metadata.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User InfoOUTLINE_GET_USER_INFOAcción

Tool to retrieve a user by their unique identifier. Returns user details including name, email, avatar, role, and status. Use when you need to fetch information about a specific user.

Parámetros de entrada

idstringObligatorio
Unique identifier for the user (UUID format).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Invite UsersOUTLINE_INVITE_USERSAcción

Tool to invite users to the Outline workspace. Use when you need to send email invitations to one or more users to join the workspace.

Parámetros de entrada

invitesobject[]Obligatorio
Array of user invitations containing email, name, and role for each user to invite

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Archived DocumentsOUTLINE_LIST_ARCHIVED_DOCUMENTSAcción

List all archived documents in the Outline workspace. Returns paginated archived documents that the current user has access to, with metadata and authorization policies. Use limit and offset for pagination through large result sets.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Collection Group MembershipsOUTLINE_LIST_COLLECTION_GROUP_MEMBERSHIPSAcción

Tool to list all group memberships for a specific collection in Outline. Use when you need to see which groups have access to a collection and their permission levels. Returns both group details and membership relationships with permissions.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List collection membershipsOUTLINE_LIST_COLLECTION_MEMBERSHIPSAcción

Tool to list all individual user memberships for a collection. Use when you need to see who has access to a specific collection and their permission levels. Note: This only returns individual user memberships, not group memberships.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List CollectionsOUTLINE_LIST_COLLECTIONSAcción

Tool to list all collections that the authenticated user has access to. Use when you need to retrieve all collections, optionally filtered by name or status, with pagination and sorting support.

Parámetros de entrada

sortstring
Field to sort collections by (e.g., 'name', 'updatedAt', 'createdAt')
limitinteger
Maximum number of collections to return per page
querystring
Search query to filter collections by name
offsetinteger
Number of collections to skip for pagination
directionstringenum
Sort direction for collections.
ASCDESC
statusFilterstring[]
Filter collections by status (e.g., archived). Omit to include all statuses.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List CommentsOUTLINE_LIST_COMMENTSAcción

Tool to retrieve all comments with optional filtering by document or collection. Use when you need to list comments, view comment threads, or monitor discussions. Supports pagination and sorting for large result sets. Returns comment data including content, authors, timestamps, and resolution status.

Parámetros de entrada

sortstring
Field name to sort comments by (e.g., 'createdAt', 'updatedAt'). Determines the ordering of results.
limitinteger
Maximum number of comments to return. Use for pagination to control response size.
offsetinteger
Number of comments to skip. Use with limit for pagination through large result sets.
directionstringenum
Sort direction enum.
ASCDESC
documentIdstringObligatorio
UUID of the document to filter comments for. Required to list comments associated with a specific document.
collectionIdstring
Filter comments to a specific collection by its UUID. Returns only comments from documents in this collection.
includeAnchorTextboolean
When true, includes the document text that the comment is anchored to in the response. Useful for providing context around inline comments.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Data AttributesOUTLINE_LIST_DATA_ATTRIBUTESAcción

Tool to list all data attributes in Outline. Use when you need to retrieve custom data attributes that can be attached to documents for structured metadata.

Parámetros de entrada

sortstring
Field name to sort results by (e.g., 'name', 'updatedAt', 'createdAt').
limitinteger
Maximum number of data attributes to return in a single request. Default is typically 25.
offsetinteger
Number of results to skip for pagination. Use with limit to paginate through results.
directionstringenum
Sort direction for listing data attributes.
ASCDESC

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Deleted DocumentsOUTLINE_LIST_DELETED_DOCUMENTSAcción

Tool to list all deleted documents in the workspace that the current user has access to. Use when you need to retrieve, review, or restore documents that have been deleted. Supports pagination and sorting to efficiently navigate through large numbers of deleted documents.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Document Group MembershipsOUTLINE_LIST_DOCUMENT_GROUP_MEMBERSHIPSAcción

Tool to list a document's group memberships. Use when you need to see which groups have access to a specific document and their permission levels.

Parámetros de entrada

idstringObligatorio
The document identifier (UUID or urlId format)
limitinteger
Maximum number of results to return for pagination
querystring
Filter results by group names
offsetinteger
Number of results to skip for pagination
permissionstring
Filter by permission level (e.g., 'read', 'read_write')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List document membershipsOUTLINE_LIST_DOCUMENT_MEMBERSHIPSAcción

Tool to list users with direct membership to a document. Use when you need to see who has direct access to a specific document and their permission levels. Note: This returns only users with direct memberships. To list all users with access to a document (including through group memberships), use documents.users instead.

Parámetros de entrada

idstringObligatorio
Unique identifier for the document. Either the UUID or the urlId is acceptable.
querystring
Filter results by user name. Search string to match against user names.
permissionstringenum
Permission levels for document access.
readread_write

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List DocumentsOUTLINE_LIST_DOCUMENTSAcción

Tool to list all documents in your Outline workspace. Returns published documents and draft documents belonging to the current user. Use filters to narrow results by collection, creator, status, or document relationships. Supports pagination for large document sets.

Parámetros de entrada

sortstring
Field name to sort results by. Common values include 'title', 'createdAt', 'updatedAt'. Defaults to the API's default sorting.
limitinteger
Maximum number of documents to return per page. Use for pagination to control result set size.
offsetinteger
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).
userIdstring
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.
directionstring
Sort direction: 'ASC' for ascending or 'DESC' for descending. Only applies when sort parameter is provided.
collectionIdstring
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.
statusFilterstring[]
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.
parentDocumentIdstring
Unique identifier of a parent document. Returns child documents (sub-pages) of this parent document. Useful for navigating document hierarchies.
backlinkDocumentIdstring
Unique identifier of a document. Returns documents that contain backlinks to this document. Useful for finding all documents that reference a specific document.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Document UsersOUTLINE_LIST_DOCUMENT_USERSAcción

Tool to list all users with access to a document. Returns all users who have any level of access to the specified document. Use when you need to see who can view or edit a document.

Parámetros de entrada

idstringObligatorio
Unique identifier for the document. Either the UUID or the urlId is acceptable.
querystring
If set, will filter the results by user name.
userIdstring
If set, will filter the results to a specific user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Draft DocumentsOUTLINE_LIST_DRAFT_DOCUMENTSAcción

Tool to list all draft documents belonging to the current user. Use when you need to retrieve unpublished documents. Supports filtering by collection, date recency, pagination, and sorting.

Parámetros de entrada

sortstring
Field name to sort by (e.g., 'title', 'updatedAt', 'createdAt').
limitinteger
Maximum number of results per page. Must be >= 1.
offsetinteger
Starting position for results (pagination offset). Must be >= 0.
directionstringenum
Sort direction.
ASCDESC
dateFilterstringenum
Date filter for documents by update recency.
dayweekmonthyear
collectionIdstring
Filter documents by collection UUID. Only returns drafts within the specified collection.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List EventsOUTLINE_LIST_EVENTSAcción

Tool to list all events from the audit trail. Use when you need to track actions taken in the knowledge base, such as document creation, permission changes, or user activity. Events provide a comprehensive audit trail for compliance and monitoring.

Parámetros de entrada

namestring
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.
sortstring
Field name to sort events by (e.g., 'createdAt'). Determines the ordering of results.
limitinteger
Maximum number of events to return per page. Use for pagination to control response size.
offsetinteger
Number of events to skip before starting to return results. Use with limit for pagination through large result sets.
actorIdstring
Filter events to those performed by a specific user. Provide the user's UUID to see all actions taken by that user.
auditLogboolean
When true, returns detailed events suitable for audit logging purposes. Use this to get comprehensive event information for compliance or security reviews.
directionstringenum
Sort direction enum.
ASCDESC
documentIdstring
Filter events to those related to a specific document. Provide the document's UUID to see its complete history.
collectionIdstring
Filter events to those related to a specific collection. Provide the collection's UUID to track all activities within that collection.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List File OperationsOUTLINE_LIST_FILE_OPERATIONSAcción

Tool to list all file operations for the workspace. Returns background jobs for importing or exporting files, filtered by type. Use to monitor export/import progress and retrieve download URLs for completed operations.

Parámetros de entrada

typestringenum
File operation type options.
exportimport
limitinteger
Maximum number of file operations to return per page. Use for pagination to control result set size.
offsetinteger
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).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Group MembershipsOUTLINE_LIST_GROUP_MEMBERSHIPSAcción

Tool to list all members of a specific group in Outline. Use when you need to see which users belong to a group. Returns user details and membership relationships.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List GroupsOUTLINE_LIST_GROUPSAcción

Tool to list all groups in the workspace. Groups organize users and manage permissions for collections. Use when you need to retrieve all groups, optionally filtered by name, with pagination and sorting support.

Parámetros de entrada

sortstring
Field to sort groups by (e.g., 'name', 'updatedAt', 'createdAt')
limitinteger
Maximum number of groups to return per page
querystring
Search query to filter groups by name
offsetinteger
Number of groups to skip for pagination
directionstringenum
Sort direction for groups.
ASCDESC

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List OAuth AuthenticationsOUTLINE_LIST_O_AUTH_AUTHENTICATIONSAcción

Tool to list all OAuth authentications for the current user. Use when you need to see which third-party applications have been authorized to access the user's account.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List OAuth ClientsOUTLINE_LIST_OAUTH_CLIENTSAcción

Tool to list all OAuth clients accessible to the authenticated user. Use when you need to retrieve OAuth clients for third-party integrations. Returns both clients created by the user and published clients available to the workspace.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Recently Viewed DocumentsOUTLINE_LIST_RECENTLY_VIEWED_DOCUMENTSAcción

Tool to list all recently viewed documents by the current user. Returns documents ordered by when they were last viewed. Supports pagination and sorting for large result sets.

Parámetros de entrada

sortstring
Field name to sort results by. Common values include 'title', 'createdAt', 'updatedAt', 'viewedAt'. Defaults to the API's default sorting.
limitinteger
Maximum number of documents to return per page. Use for pagination to control result set size.
offsetinteger
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).
directionstring
Sort direction: 'ASC' for ascending or 'DESC' for descending. Only applies when sort parameter is provided.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List RevisionsOUTLINE_LIST_REVISIONSAcción

Tool to list all revisions for a specific document. Revisions represent historical snapshots of document content and are useful for tracking changes over time. Use when you need to view a document's editing history or restore to a previous version.

Parámetros de entrada

sortstring
Field name to sort revisions by (e.g., 'createdAt'). Determines the ordering of results.
limitinteger
Maximum number of revisions to return per page. Use for pagination to control response size.
offsetinteger
Number of revisions to skip before starting to return results. Use with limit for pagination through large result sets.
directionstringenum
Sort direction enum.
ASCDESC
documentIdstringObligatorio
Unique identifier of the document to retrieve revisions for. This is required to specify which document's revision history you want to access.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List SharesOUTLINE_LIST_SHARESAcción

Tool to list all share links in the workspace. Use when you need to retrieve all public document shares, optionally filtered by search query, with pagination and sorting support.

Parámetros de entrada

sortstring
Field to sort shares by (e.g., 'updatedAt', 'createdAt')
limitinteger
Maximum number of shares to return per page
querystring
Filter to shared documents matching a search query
offsetinteger
Number of shares to skip for pagination
directionstringenum
Sort direction for shares.
ASCDESC

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List StarsOUTLINE_LIST_STARSAcción

Tool to list all starred documents and collections for the authenticated user. Use when you need to retrieve bookmarked items that users have marked for quick access in their sidebar.

Parámetros de entrada

sortstring
Field name to sort stars by (e.g., 'createdAt'). Determines the ordering of results.
limitinteger
Maximum number of starred items to return per page. Use for pagination to control response size.
offsetinteger
Number of starred items to skip before starting to return results. Use with limit for pagination through large result sets.
userIdstring
Filter starred items to those created by a specific user. Provide the user's UUID to see their bookmarked documents and collections.
directionstringenum
Sort direction enum.
ASCDESC

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List TemplatesOUTLINE_LIST_TEMPLATESAcción

Tool to list all templates available to the current user. Use when you need to retrieve all templates, optionally filtered by collection or name, with pagination and sorting support. Templates not associated with a collection are workspace-wide.

Parámetros de entrada

sortstring
Field to sort templates by (e.g., 'title', 'createdAt', 'updatedAt')
limitinteger
Maximum number of templates to return per page
querystring
Search query to filter templates by name
offsetinteger
Number of templates to skip for pagination
directionstringenum
Sort direction for templates.
ASCDESC
collectionIdstring
Filter templates to a specific collection by its UUID. Templates not associated with a collection are workspace-wide.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List UsersOUTLINE_LIST_USERSAcción

Tool to list all users in the workspace. Use when you need to retrieve all users, optionally filtered by name, email, or status, with pagination and sorting support.

Parámetros de entrada

sortstring
Field to sort users by (e.g., 'name', 'email', 'createdAt', 'updatedAt', 'lastActiveAt')
limitinteger
Maximum number of users to return per page
querystring
Search query to filter users by name or email
filterstringenum
Filter users by status.
activeinvitedsuspended
offsetinteger
Number of users to skip for pagination
directionstringenum
Sort direction for users.
ASCDESC

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ViewsOUTLINE_LIST_VIEWSAcción

Tool to list all users that have viewed a specific document and the overall view count. Use when you need to see who has accessed a document and how many times they've viewed it. Returns view records including first/last view timestamps and total view counts per user.

Parámetros de entrada

documentIdstringObligatorio
Unique identifier of the document to retrieve views for. Returns all users who have viewed this document and the total view count.
includeSuspendedboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Move DocumentOUTLINE_MOVE_DOCUMENTAcción

Tool to move a document to a new location or collection in Outline. Use when you need to reorganize documents by moving them to a different collection or nesting them under a different parent document.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Redirect File OperationOUTLINE_REDIRECT_FILE_OPERATIONAcción

Tool to retrieve a file from Outline by file operation ID. Loads the resulting file from where it is stored based on the id. A temporary signed URL with embedded credentials is generated on demand. Use when you need to access or download an exported file.

Parámetros de entrada

idstringObligatorio
Unique identifier for the file operation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Collection GroupOUTLINE_REMOVE_COLLECTION_GROUPAcción

Tool to remove a group from a collection, revoking access for all group members. Use when you need to remove group-level access to a collection. Note that members may retain access through other groups or individual memberships.

Parámetros de entrada

idstringObligatorio
Identifier for the collection
groupIdstringObligatorio
Group ID to remove from the collection

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Collection UserOUTLINE_REMOVE_COLLECTION_USERAcción

Tool to remove a user from a collection. Use when you need to revoke a user's access to a specific collection in Outline.

Parámetros de entrada

idstringObligatorio
Identifier for the collection from which the user will be removed
userIdstringObligatorio
Identifier for the user to remove from the collection

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Document UserOUTLINE_REMOVE_DOCUMENT_USERAcción

Tool to remove a user membership from a document. Use when you need to revoke a user's access to a specific document.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Group from DocumentOUTLINE_REMOVE_GROUP_FROM_DOCUMENTAcción

Tool to remove a group from a document, revoking access for all group members. Use when you need to revoke document-level access for an entire group at once.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Group UserOUTLINE_REMOVE_GROUP_USERAcción

Tool to remove a user from a group. Use when you need to revoke a user's group membership in Outline.

Parámetros de entrada

idstringObligatorio
Identifier for the group from which the user will be removed
userIdstringObligatorio
Identifier for the user to remove from the group

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Restore DocumentOUTLINE_RESTORE_DOCUMENTAcción

Tool to restore a document in Outline. If a document has been archived or deleted, it can be restored. Optionally a revision can be passed to restore the document to a previous point in time.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Restore TemplateOUTLINE_RESTORE_TEMPLATEAcción

Tool to restore a previously deleted template in Outline. Use when you need to recover a template that was soft-deleted.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Auth InfoOUTLINE_RETRIEVE_AUTH_INFOAcción

Tool to retrieve authentication details for the current API key. Use when you need to verify that an API token is valid or obtain identifying information for the authenticated user and workspace.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Revoke ShareOUTLINE_REVOKE_SHAREAcción

Tool to revoke a share in Outline, making the share link inactive so it can no longer be used to access the document. Use when you need to disable public access to a shared document.

Parámetros de entrada

idstringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rotate OAuth Client SecretOUTLINE_ROTATE_OAUTH_CLIENT_SECRETAcción

Tool to rotate the secret for an OAuth client in Outline. Use when you need to generate a new client secret for an OAuth client. The old secret will be invalidated immediately.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search DocumentsOUTLINE_SEARCH_DOCUMENTSAcción

Tool to search all documents in your Outline workspace using keywords. Results are restricted to documents accessible by the current access token. Use filters to narrow results by collection, user, status, or timeframe. Supports sorting by relevance, date, or title.

Parámetros de entrada

sortstring
Field name to sort results by. Accepted values: 'relevance' (default, best match first), 'createdAt', 'updatedAt', or 'title'.
limitinteger
Maximum number of documents to return per page. Use for pagination to control result set size.
querystringObligatorio
Search keywords to find matching documents. Use natural language search terms. Required parameter.
offsetinteger
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).
userIdstring
Unique identifier of the user. Filters documents edited by this specific user. Useful for finding documents modified by a team member.
shareIdstring
Filters search by collection or document referenced via share ID. Use this when working with shared document links.
directionstring
Sort direction: 'ASC' for ascending or 'DESC' for descending. Only applies when sort parameter is provided.
dateFilterstring
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).
documentIdstring
Unique identifier of a document. Searches within this document and all its children (sub-pages). Useful for searching within a specific document hierarchy.
collectionIdstring
Unique identifier of the collection. Restricts search to documents within this particular collection only.
statusFilterstring[]
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Document TitlesOUTLINE_SEARCH_DOCUMENT_TITLESAcción

Tool to search document titles in Outline workspace using keywords. Unlike full document search, this searches only titles and returns faster results. Use when you need to quickly find documents by their title. Supports filters for collection, creator, status, and date range.

Parámetros de entrada

sortstringenum
Sort field options for search results.
relevancecreatedAtupdatedAttitle
limitinteger
Maximum number of documents to return per page. Use for pagination to control result set size.
querystringObligatorio
Search query to match against document titles. This searches only titles, not content, for faster results.
offsetinteger
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).
userIdstring
Filter results by document creator. Only documents created by this user will be returned.
shareIdstring
Filter results for the collection or document referenced by the shareId. Useful for searching within shared content.
directionstringenum
Sort direction options.
ASCDESC
dateFilterstringenum
Date filter period values.
dayweekmonthyear
documentIdstring
Filter results to content within a specific document and its children. Useful for searching within a document hierarchy.
collectionIdstring
Filter results to a specific collection by its UUID. Only documents within this collection will be returned.
statusFilterstring[]
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Suspend UserOUTLINE_SUSPEND_USERAcción

Tool to suspend a user in Outline. Suspending a user prevents them from signing in and they are not counted against billing totals. Use when you need to temporarily disable a user's access without deleting their account.

Parámetros de entrada

idstringObligatorio
Unique identifier for the user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Template from DocumentOUTLINE_TEMPLATIZE_DOCUMENTAcción

Tool to create a template from an existing Outline document. Use when you need to convert a document into a reusable template for your workspace.

Parámetros de entrada

idstringObligatorio
Unique identifier for the document to convert into a template. Either the UUID or the urlId is acceptable.
publishbooleanObligatorio
Whether the new template should be published. Set to true to make the template immediately available to workspace members.
collectionIdstring
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unpublish DocumentOUTLINE_UNPUBLISH_DOCUMENTAcción

Tool to unpublish a document in Outline. Unpublishing moves the document back to draft status and removes it from the collection. Use when you need to make a published document private again.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update CollectionOUTLINE_UPDATE_COLLECTIONAcción

Tool to update an existing collection's properties in Outline. Use when you need to modify collection settings such as name, description, icon, color, sharing settings, or permission level.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update CommentOUTLINE_UPDATE_COMMENTAcción

Tool to update a comment in Outline. Use when you need to modify the content of an existing comment. The comment body should be provided in ProseMirror document format with type and content fields.

Parámetros de entrada

idstringObligatorio
The unique identifier for the comment to update (UUID format).
dataobjectObligatorio
The comment body content in ProseMirror document format. Should include 'type' (typically 'doc') and 'content' array with paragraph objects containing text nodes.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update DocumentOUTLINE_UPDATE_DOCUMENTAcción

Tool to update a document in Outline. Use when you need to modify an existing document's title, content, or metadata. At least the document ID is required.

Parámetros de entrada

idstringObligatorio
Unique identifier for the document. Either the UUID or the urlId is acceptable.
iconstring
Icon displayed alongside the document title
textstring
The body of the document in markdown.
colorstring
Color for the document icon in hex format
titlestring
The title of the document.
publishboolean
Whether this document should be published and made visible to other workspace members, if a draft
editModestring
Edit mode
fullWidthboolean
Whether the document should be displayed in full width
templateIdstring
Identifier for the template this document is based on
collectionIdstring
Identifier for the collection to move the document to
dataAttributesobject[]
Data attributes to be updated. Attributes not included will be removed from the document.
insightsEnabledboolean
Whether insights should be visible on the document

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update GroupOUTLINE_UPDATE_GROUPAcción

Tool to update an existing group's name in Outline. Use when you need to rename a group.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update OAuth ClientOUTLINE_UPDATE_O_AUTH_CLIENTAcción

Tool to update an existing OAuth client in Outline. Use when you need to modify an OAuth client's properties such as name, description, redirect URIs, or published status.

Parámetros de entrada

idstringObligatorio
Unique identifier for the OAuth client to update
namestring
Name of the OAuth client
avatarUrlstring
A URL pointing to an image representing the OAuth client
publishedboolean
Whether the OAuth client is available to other workspaces
descriptionstring
A short description of this OAuth client
developerUrlstring
The URL of the developer who created this OAuth client
redirectUrisstring[]
List of redirect URIs for the OAuth client. These URIs are used for OAuth callbacks after authentication
developerNamestring
The name of the developer who created this OAuth client

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ShareOUTLINE_UPDATE_SHAREAcción

Tool to update a share in Outline. Use when you need to change a share's published status, which controls whether authentication is required to access the shared link.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update StarOUTLINE_UPDATE_STARAcción

Tool to update a star's position in the Outline sidebar. Use when you need to reorder a user's starred documents or collections by changing the display index.

Parámetros de entrada

idstringObligatorio
The unique identifier (UUID) of the star to update. This determines which starred item's position will be changed in the sidebar.
indexstringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update TemplateOUTLINE_UPDATE_TEMPLATEAcción

Tool to update an existing template in Outline. Use when you need to modify a template's title, content, icon, color, or other properties. At least the template ID is required.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update UserOUTLINE_UPDATE_USERAcción

Tool to update a user's name, avatar, or language preference in Outline. If no ID is provided, updates the authenticated user. Use when you need to modify user profile information.

Parámetros de entrada

idstring
Unique identifier for the user to update. If not provided, updates the authenticated user.
namestring
User name to update.
languagestring
Language preference for the user.
avatarUrlstring
URL to the user's avatar image.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update User RoleOUTLINE_UPDATE_USER_ROLEAcción

Tool to change a user's role in Outline workspace. Use when you need to promote a user to admin, demote an admin to member, or change a user to viewer role. Only available to admin users.

Parámetros de entrada

idstringObligatorio
Unique identifier for the user whose role you want to change (UUID format).
rolestringObligatorioenum
New role to assign to the user. Admin: full permissions. Member: standard workspace access. Viewer: read-only access.
adminmemberviewerguest

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not