Outline integration: operations for AI agents
Outline connects to Type.com as an integration. This page lists the 153 operations documented for Claude and Codex in Type.com: 62 read, 64 write, 27 destructive.
About Outline
Team knowledge base and wiki for managing documentation and collaboration
Categories: Productivity & Project Management
How to connect Outline to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
153 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
153 operations listed.
Access Requests
- Read
Retrieve an access request
Retrieve information about an access request by id, or the current user's pending request for a document by documentId. At least one of these parameters must be provided.
- Write
Create an access request
Request access to a document. The request will be sent to users with permission to share the document for approval or dismissal.
- Write
Approve an access request
Approve a pending access request, granting the requesting user a membership on the document with the specified permission.
- Write
Dismiss an access request
Dismiss a pending access request without granting the requesting user access to the document.
Api Keys
- Read
List API keys
List API keys for the authenticated user, or for all users in the workspace when called by an administrator. The secret key value is never included in this response.
- Write
Create an API key
Create a new personal API key for the authenticated user. The full key value is only returned in this response and cannot be retrieved again, so it should be stored securely.
- Destructive
Delete an API key
Permanently revoke an API key. Any requests made with the key afterwards will be rejected.
Attachments
- Read
Retrieve an attachment
Load an attachment from where it is stored based on the id. If the attachment is private then a temporary, signed url with embedded credentials is generated on demand.
- Read
List all attachments
List all attachments in the workspace, optionally filtered by the document or user they are associated with.
- Write
Create an attachment
Creating an attachment object creates a database record and returns the inputs needed to generate a signed url and upload the file from the client to cloud storage.
- Write
Create an attachment from a URL
Fetch a file from a remote URL and store it as an attachment. Unlike attachments.create, the server downloads and uploads the file, so the returned attachment is immediately available.
- Destructive
Delete an attachment
Deleting an attachment is permanent. It will not delete references or links to the attachment that may exist in your documents.
Auth
- Read
Retrieve auth
Retrieve authentication details for the current API key
- Read
Retrieve auth config
Retrieve authentication options
- Write
Sign out
Sign out the authenticated user. This rotates the user's token secret, immediately invalidating all existing API tokens and sessions for that user.
Collections
- Read
Retrieve a collection
Retrieve the details of a collection by its unique identifier.
- Read
Retrieve a collections document structure
Returns the document structure of a collection as a tree of navigation nodes, representing the hierarchy of documents within the collection.
- Read
List all collections
List all collections that the authenticated user has access to.
- Read
List all collection memberships
This method allows you to list a collections individual memberships. It's important to note that memberships returned from this endpoint do not include group memberships.
- Read
List all collection group members
This method allows you to list a collections group memberships. This is the list of groups that have been given access to the collection.
- Read
Export a collection
Triggers a bulk export of the collection in markdown format and their attachments. If documents are nested then they will be nested in folders inside the zip file.
- Read
Export all collections
Triggers a bulk export of multiple collections and their documents. The endpoint returns a FileOperation that can be queried through the fileOperations endpoint to track the progress of the export and get the url for the final file.
- Write
Create a collection
Create a new collection with the specified name, description, icon, color, and permission settings. Collections are used to organize documents.
- Write
Duplicate a collection
Duplicate an existing collection along with its published documents. The original collection's settings – icon, color, permission, sharing, and sorting – are preserved on the copy. Draft and archived documents are not duplicated.
- Write
Update a collection
Update an existing collection's properties such as name, description, icon, color, sharing settings, or permission level.
- Write
Add a collection user
This method allows you to add a user membership to the specified collection.
- Write
Add a group to a collection
This method allows you to give all members in a group access to a collection.
- Write
Restore an archived collection
Restore a previously archived collection, making it and the documents within it visible in the sidebar and search results once again.
- Write
Move a collection
Move a collection to a new position in the sidebar. Collections are ordered using a fractional index; provide the new index to reposition the collection relative to its siblings.
- Write
Import documents into a new collection
Import a file that was previously uploaded through attachments.create and create a new collection from its contents. The endpoint returns a FileOperation that can be queried to track the progress of the import.
- Destructive
Remove a collection user
This method allows you to remove a user from the specified collection.
- Destructive
Remove a collection group
This method allows you to revoke all members in a group access to a collection. Note that members of the group may still retain access through other groups or individual memberships.
- Destructive
Delete a collection
Delete a collection and all of its documents. This action can’t be undone so please be careful.
- Destructive
Archive a collection
Archiving a collection hides it, and all of the documents within it, from the sidebar and search results. Archived collections can be restored at a later date.
Comments
- Read
Retrieve a comment
Retrieve a comment
- Read
List all comments
This method will list all comments matching the given properties.
- Write
Create a comment
Add a comment or reply to a document, either data or text is required. Provide anchorText to create an inline comment attached to a specific text range in the document.
- Write
Update a comment
Update a comment, either data or text is required.
- Write
Resolve a comment
Mark a comment thread as resolved. Resolved comments are hidden from the document by default and indicate that the discussion has been dealt with.
- Write
Unresolve a comment
Mark a previously resolved comment thread as unresolved, making it visible on the document again.
- Write
Add a reaction to a comment
Add an emoji reaction to a comment on behalf of the authenticated user.
- Destructive
Delete a comment
Deletes a comment. If the comment is a top-level comment, all its children will be deleted as well.
- Destructive
Remove a reaction from a comment
Remove an emoji reaction that the authenticated user previously added to a comment.
Data Attributes
- Read
Retrieve a data attribute
Retrieve a data attribute by its unique identifier.
- Read
List all data attributes
List all data attributes.
- Write
Create a data attribute
Create a new data attribute. Only admins can create data attributes.
- Write
Update a data attribute
Update an existing data attribute. Only admins can update data attributes. Note that the dataType cannot be changed after creation.
- Destructive
Delete a data attribute
Delete a data attribute. Only admins can delete data attributes.
Documents
- Read
Retrieve a document
Retrieve a document by its UUID, urlId, or shareId. At least one of these parameters must be provided.
- Read
Retrieve insights for a document
Retrieve a chronologically sorted array of activity rollups (views, comments, reactions, revisions, editors) for a document. Recent activity is returned as daily rollups, while older activity is aggregated into weekly rollups. Insights must be enabled on the document.
- Read
Export a document.
Export a document in Markdown, HTML, PDF, or TextBundle format. The response format is determined by the Accept header (text/markdown, text/html, application/pdf, or application/x-textbundle). Optionally include child documents in the export as a zip file.
- Read
List all documents
This method will list all published documents and draft documents belonging to the current user.
- Read
Retrieve a document's child structure
This method returns the nested document structure (tree) for the children of the specified document.
- Read
List all draft documents
This method will list all draft documents belonging to the current user.
- Read
List all recently viewed documents
This method will list all documents recently viewed by the current user.
- Read
Query documents with natural language
This method allows asking direct questions of your documents – where possible an answer will be provided. Search results will be restricted to those accessible by the current access token. Note that "AI answers" must be enabled for the workspace.
- Read
Search document titles
This method allows you to search document titles with keywords. Unlike documents.search, this only searches titles and returns faster results.
- Read
Search all documents
This methods allows you to search your workspace's documents with keywords. Note that search results will be restricted to those accessible by the current access token.
- Read
List document users
All users with access to a document. To list only users with direct membership to the document use documents.memberships
- Read
List document memberships
Users with direct membership to a document. To list all users with access to a document use documents.users.
- Read
List all archived documents
This method will list all archived documents belonging to the workspace that the current user has access to.
- Read
List all deleted documents
This method will list all deleted documents belonging to the workspace that the current user has access to.
- Read
List document group memberships
This method allows you to list a document's group memberships.
- Write
Import a file as a document
This method allows you to create a new document by importing an existing file. By default a document is set to the collection root. If you want to create a nested/child document, you should pass parentDocumentId to set the parent document.
- Write
Create a document
This method allows you to create or publish a new document. By default a document is set to the collection root. If you want to create a nested/child document, you should pass parentDocumentId to set the parent document.
- Write
Update a document
This method allows you to modify an already created document
- Write
Create a template from a document
This method allows you to create a new template using an existing document as the basis
- Write
Unpublish a document
Unpublishing a document moves it back to a draft status and out of the collection.
- Write
Move a document
Move a document to a new location or collection. If no parent document is provided, the document will be moved to the collection root.
- Write
Restore a document
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.
- Write
Add a document user
This method allows you to add a user membership to the specified document.
- Write
Duplicate a document
This method allows you to duplicate an existing document and optionally all of its child documents.
- Write
Add a group to a document
This method allows you to give all members in a group access to a document.
- Destructive
Archive a document
Archiving a document allows outdated information to be moved out of sight whilst retaining the ability to optionally search and restore it later.
- Destructive
Delete a document
Deleting a document moves it to the trash. If not restored within 30 days it is permanently deleted.
- Destructive
Remove a document user
This method allows you to remove a user membership from the specified document.
- Destructive
Remove a group from a document
This method allows you to revoke all members in a group access to a document.
- Destructive
Empty trash
Permanently delete all documents in the trash. This action is irreversible. Only available to admin users.
Events
- Read
List all events
Events are an audit trail of important events that happen in the knowledge base.
File Operations
- Read
Retrieve a file operation
Retrieve the details and current status of a file operation by its unique identifier. File operations represent long-running import or export tasks.
- Read
Retrieve the file
Load the resulting file from where it is stored based on the id. A temporary, signed url with embedded credentials is generated on demand.
- Read
List all file operations
List all file operations for the current workspace, filtered by type (import or export).
- Destructive
Delete a file operation
Delete a file operation and its associated files. This is useful for cleaning up completed or failed import/export operations.
Group Memberships
- Read
List group memberships
List the documents that have been shared with groups the authenticated user belongs to, along with the associated group membership records.
Groups
- Read
Retrieve a group
Retrieve the details of a group by its unique identifier, including its name and member count.
- Read
List all groups
List all groups in the workspace. Groups are used to organize users and manage permissions for collections.
- Read
List all group members
List and filter all the members in a group.
- Write
Create a group
Create a new group with the specified name. Groups can be used to organize users and assign collection permissions to multiple users at once.
- Write
Update a group
Update an existing group's name. The group is identified by its unique identifier.
- Write
Add a group member
This method allows you to add a user to the specified group.
- Write
Update a group member
Update the role of an existing member of a group, for example to promote them to a group admin or demote them back to a regular member.
- Destructive
Delete a group
Deleting a group will cause all of its members to lose access to any collections the group has previously been added to. This action can’t be undone so please be careful.
- Destructive
Remove a group member
This method allows you to remove a user from the group.
Notifications
- Read
List notifications
List the authenticated user's notifications, most recent first, optionally filtered by event type or archived status.
- Write
Update a notification
Update a single notification, for example to mark it as viewed or archived by setting the relevant timestamp.
- Write
Update all notifications
Update all of the authenticated user's notifications at once, for example to mark them all as viewed or archived.
OAuth Authentications
- Read
List accessible OAuth authentications
List all OAuth authentications for the current user. These represent the third-party applications that the user has authorized to access their account.
- Destructive
Delete an OAuth authentiation
Revoke an OAuth authentication, removing the third-party application's access to the user's account.
OAuth Clients
- Read
Retrieve an OAuth client
To retrieve information about an OAuth client you must pass either an id or a clientId.
- Read
List accessible OAuth clients
List all OAuth clients that the authenticated user has access to. This includes both clients created by the user and published clients available to the workspace.
- Write
Create an OAuth client
Create a new OAuth client application that can be used to authenticate users and access the API on their behalf.
- Write
Update an OAuth client
Update an existing OAuth client's properties such as name, description, redirect URIs, or published status.
- Write
Rotate the secret for an OAuth client
Generate a new client secret for an OAuth client. The old secret will be invalidated immediately, so ensure your application is updated to use the new secret.
- Destructive
Delete an OAuth client
Permanently delete an OAuth client and revoke all associated access tokens. This action cannot be undone.
Pins
- Read
Retrieve a pin
Retrieve the pin for a document, either within a collection or on the home screen.
- Read
List pins
List the pinned documents for a collection, or for the home screen when no collectionId is provided.
- Write
Pin a document
Pin a document to the top of a collection or to the home screen. Pinned documents are visible to all members of the workspace. Provide a collectionId to pin within a collection, or omit it to pin to the home screen.
- Write
Update a pin
Update the position of an existing pin, used to reorder pinned documents.
- Destructive
Delete a pin
Remove a pin, un-pinning the document from its collection or the home screen. The document itself is not affected.
Reactions
- Read
List reactions
List the emoji reactions that have been added to a comment.
Revisions
- Read
Retrieve a revision
A revision is a snapshot of a document at a specific point in time. This endpoint allows you to retrieve a specific version of a document by its unique identifier.
- Read
List all revisions
List all revisions for a specific document. Revisions represent historical snapshots of a document's content and can be used to track changes over time.
- Read
Export a revision
Triggers an export of a single revision to a file. The endpoint returns a FileOperation that can be queried to track the progress of the export and get the url for the final file.
- Write
Update a revision
Update the details of a revision. Currently only the name of the revision can be changed, which is used to label significant versions of a document.
- Destructive
Delete a revision
Delete a specific revision of a document. The latest revision of a document cannot be deleted.
Shares
Stars
- Read
List all stars
List all starred documents for the authenticated user. Stars allow users to bookmark important documents for quick access in the sidebar.
- Write
Create a star
Stars a document or collection so it appears in the users sidebar. One of either documentId or collectionId must be provided.
- Write
Update a stars order in the sidebar
Update the position of a starred document in the sidebar. The index parameter determines the display order relative to other starred documents.
- Destructive
Delete a star
Remove a star from a document, removing it from the user's starred documents list in the sidebar.
Subscriptions
- Read
List subscriptions
List the authenticated user's subscriptions for a given document or collection.
- Read
Retrieve a subscription
Retrieve the authenticated user's subscription for a specific document or collection, if one exists.
- Write
Create a subscription
Subscribe the authenticated user to a document or collection so that they receive notifications when it changes. Provide exactly one of documentId or collectionId.
- Destructive
Delete a subscription
Unsubscribe the authenticated user from a document or collection by the subscription's identifier.
Templates
- Read
List all templates
List all templates available to the current user. Optionally filter by collection. Templates not associated with a collection are workspace-wide.
- Read
Retrieve a template
Retrieve a template by its unique identifier.
- Write
Create a template
Create a new template that can be used as a starting point for new documents. Templates can optionally be scoped to a specific collection.
- Write
Update a template
Update an existing template by its unique identifier.
- Write
Restore a template
Restore a previously deleted template by its unique identifier.
- Write
Duplicate a template
Create a copy of an existing template. Optionally override the title and target collection.
- Destructive
Delete a template
Delete a template by its unique identifier. This will soft-delete the template, it can be restored later.
User Memberships
- Read
List document memberships
List the documents that have been shared directly with the authenticated user, along with the associated membership records.
- Write
Update a document membership
Update the authenticated user's membership of a shared document, used to reorder documents in the sidebar.
Users
- Read
Retrieve a user
Retrieve the details of a user by their unique identifier, including their name, email, avatar, and role within the workspace.
- Read
List all users
List and filter all the users in the workspace
- Write
Invite users
Send email invitations to one or more users to join the workspace. Invitations include a link to create an account and join the workspace.
- Write
Update a user
Update a users name or avatar. If no id is passed then the user associated with the authentication will be updated by default.
- Write
Change a users role
Change the role of a user, only available to admin authorization.
- Write
Suspend a user
Suspending a user prevents the user from signing in. Users that are suspended are also not counted against billing totals in the hosted version.
- Write
Activate a user
Activating a previously suspended user allows them to signin again. Users that are activated will cause billing totals to be re-calculated in the hosted version.
- Write
Resend a user invite
Resend the invitation email to a user who has been invited but has not yet signed in. Only applies to users in the invited state.
- Write
Subscribe to a notification type
Enable a specific type of notification for the authenticated user. This controls which events the user receives email and in-app notifications for.
- Write
Unsubscribe from a notification type
Disable a specific type of notification for the authenticated user.
- Destructive
Delete a user
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.
Views
- Read
List all views
List all users that have viewed a document and the overall view count.
Webhook Subscriptions
- Read
List all webhook subscriptions
List all webhook subscriptions for the workspace. Only workspace administrators can access this endpoint.
- Write
Create a webhook subscription
Create a webhook subscription for the workspace. Only workspace administrators can access this endpoint.
- Write
Update a webhook subscription
Update an existing webhook subscription. Updating a disabled subscription enables it again. Only workspace administrators can access this endpoint.
- Destructive
Delete a webhook subscription
Delete a webhook subscription. Only workspace administrators can access this endpoint.
No operations match.
See How connections work for access and permissions, or browse all integrations.