API Reference

Outline is built on an open, best-in-class, API

auth.info Get current auth

This method returns the user and team info for the user identified by the token.

HTTP request & arguments

https://www.getoutline.com/api/auth.info

ArgumentRequiredDescription
tokenrequiredAuthentication token

events.list List team's events

List all of the events in the team.

HTTP request & arguments

https://www.getoutline.com/api/events.list

ArgumentRequiredDescription
tokenrequiredAuthentication token
offsetoptionalPagination offset
limitoptionalPagination limit
auditLogoptionalBoolean. If user token has access, return auditing events

users.list List team's users

List all of the users in the team.

HTTP request & arguments

https://www.getoutline.com/api/users.list

ArgumentRequiredDescription
tokenrequiredAuthentication token
offsetoptionalPagination offset
limitoptionalPagination limit

users.info Get current user

This method returns the profile info for the user identified by the token.

HTTP request & arguments

https://www.getoutline.com/api/users.info

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredCollection id

users.s3Upload Get S3 upload credentials

You can upload small files and images as part of your documents. All files are stored using Amazon S3. Instead of uploading files to Outline, you need to upload them directly to S3 with special credentials which can be obtained through this endpoint.

HTTP request & arguments

https://www.getoutline.com/api/users.s3Upload

ArgumentRequiredDescription
tokenrequiredAuthentication token
filenamerequiredFilename of the uploaded file
kindrequiredMimetype of the document
sizerequiredFilesize of the document

users.promote Promote a new admin user

Promote a user to be a team admin. This endpoint is only available for admin users.

HTTP request & arguments

https://www.getoutline.com/api/users.promote

ArgumentRequiredDescription
tokenrequiredAuthentication token
offsetoptionalPagination offset
limitoptionalPagination limit
idrequiredUser ID to be promoted

users.demote Demote existing admin user

Demote existing team admin if there are more than one as one admin is always required. This endpoint is only available for admin users.

HTTP request & arguments

https://www.getoutline.com/api/users.demote

ArgumentRequiredDescription
tokenrequiredAuthentication token
offsetoptionalPagination offset
limitoptionalPagination limit
idrequiredUser ID to be demoted

users.suspend Suspend user account

Admin can suspend users to reduce the number of accounts on their billing plan or prevent them from accessing documention.

HTTP request & arguments

https://www.getoutline.com/api/users.suspend

ArgumentRequiredDescription
tokenrequiredAuthentication token
offsetoptionalPagination offset
limitoptionalPagination limit
idrequiredUser ID to be suspended

users.activate Activate a suspended user account

Admin can re-active a suspended user. This will update the billing plan and re-enable their access to the documention.

HTTP request & arguments

https://www.getoutline.com/api/users.activate

ArgumentRequiredDescription
tokenrequiredAuthentication token
offsetoptionalPagination offset
limitoptionalPagination limit
idrequiredUser ID to be activated

collections.list List your document collections

List all your document collections.

HTTP request & arguments

https://www.getoutline.com/api/collections.list

ArgumentRequiredDescription
tokenrequiredAuthentication token
offsetoptionalPagination offset
limitoptionalPagination limit

collections.info Get a collection

Returns detailed information on a document collection.

HTTP request & arguments

https://www.getoutline.com/api/collections.info

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredCollection id

collections.create Create a document collection

Creates a new document collection.

HTTP request & arguments

https://www.getoutline.com/api/collections.create

ArgumentRequiredDescription
tokenrequiredAuthentication token
namerequiredCollection name
descriptionoptionalShort description for the collection

collections.export Export a collection

Returns a zip file of all the collections documents in markdown format. If documents are nested then they will be nested in folders inside the zip file.

HTTP request & arguments

https://www.getoutline.com/api/collections.export

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredCollection id

collections.exportAll Export all collections

Returns a zip file of all the collections or creates an async job to send a zip file via email to the authenticated user. If documents are nested then they will be nested in folders inside the zip file.

HTTP request & arguments

https://www.getoutline.com/api/collections.exportAll

ArgumentRequiredDescription
tokenrequiredAuthentication token
downloadoptionalDownload as zip (default is email)

collections.update Update a collection

This method allows you to modify an already created collection.

HTTP request & arguments

https://www.getoutline.com/api/collections.update

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredCollection ID
nameoptionalName for the collection
privateoptionalBoolean
coloroptionalCollection color in hex form (e.g. #E1E1E1)

collections.add_user Add a collection member

This method allows you to add a user to a private collection.

HTTP request & arguments

https://www.getoutline.com/api/collections.add_user

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredCollection ID
userIdoptionalUser ID to add to the collection

collections.remove_user Remove a collection member

This method allows you to remove a user from a private collection.

HTTP request & arguments

https://www.getoutline.com/api/collections.remove_user

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredCollection ID
userIdoptionalUser ID to remove from the collection

collections.users List collection members

This method allows you to list users with access to a private collection.

HTTP request & arguments

https://www.getoutline.com/api/collections.users

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredCollection ID

collections.delete Delete a collection

Delete a collection and all of its documents. This action can’t be undone so please be careful.

HTTP request & arguments

https://www.getoutline.com/api/collections.delete

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredCollection ID

documents.list List your documents

List all published documents.

HTTP request & arguments

https://www.getoutline.com/api/documents.list

ArgumentRequiredDescription
tokenrequiredAuthentication token
offsetoptionalPagination offset
limitoptionalPagination limit
collectionoptionalCollection ID to filter by
useroptionalUser ID to filter by
backlinkDocumentIdoptionalBacklinked document ID to filter by

documents.drafts List your draft documents

List all your draft documents.

HTTP request & arguments

https://www.getoutline.com/api/documents.drafts

documents.info Get a document

This method returns information for a document with a specific ID. The following identifiers are allowed:

  • UUID - id field of the document
  • URI identifier - Human readable identifier used in Outline URLs (e.g. outline-api-i48ZEZc5zjXndcP)

HTTP request & arguments

https://www.getoutline.com/api/documents.info

ArgumentRequiredDescription
tokenrequiredAuthentication token
idoptionalDocument ID or URI identifier
shareIdoptionalAn active shareId

documents.search Search documents

This methods allows you to search your teams documents with keywords. Search results will be restricted to those accessible by the current access token.

HTTP request & arguments

https://www.getoutline.com/api/documents.search

ArgumentRequiredDescription
tokenrequiredAuthentication token
queryrequiredSearch query
userIdoptionalUser ID
collectionIdoptionalCollection ID
includeArchivedoptionalBoolean
dateFilteroptionalDate range to consider (day, week, month or year)

documents.create Create a new document

This method allows you to publish a new document under an existing collection. By default a document is set to the parent collection root. If you want to create a subdocument, you can pass parentDocumentId to set parent document.

HTTP request & arguments

https://www.getoutline.com/api/documents.create

ArgumentRequiredDescription
tokenrequiredAuthentication token
collectionIdrequiredID of the collection to which the document is created
titleoptionalTitle for the document
textrequiredContent of the document in Markdow
parentDocumentIdoptionalID of the parent document within the collection
publishoptionaltrue by default. Pass false to create a draft.

documents.update Update a document

This method allows you to modify already created document.

HTTP request & arguments

https://www.getoutline.com/api/documents.update

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredDocument ID or URI identifier
titleoptionalTitle for the document
textoptionalContent of the document in Markdown
publishoptionalPass true to publish a draft.
appendoptionalPass true to append the text parameter to the end of the document rather than replace.
autosaveoptionalPass true to signify an autosave. This skips creating a revision.
doneoptionalPass true to signify the end of an editing session. This will trigger update notifications.

documents.move Move document in a collection

Move a document to a new location or collection. If no parent document is provided, the document will be moved to the collection root.

HTTP request & arguments

https://www.getoutline.com/api/documents.move

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredDocument ID or URI identifier
collectionIdrequiredID of the collection
parentDocumentIdoptionalID of the new parent document

documents.archive Archive a document

Archive a document and all of its child documents, if any.

HTTP request & arguments

https://www.getoutline.com/api/documents.archive

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredDocument ID or URI identifier

documents.delete Delete a document

Permanantly delete a document and all of its child documents, if any.

HTTP request & arguments

https://www.getoutline.com/api/documents.delete

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredDocument ID or URI identifier

documents.info Get a document

Get a document with its ID or URL identifier from user’s collections.

HTTP request & arguments

https://www.getoutline.com/api/documents.info

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredDocument ID or URI identifier

documents.restore Restore a previous revision

Restores a document to a previous revision by creating a new revision with the contents of the given revisionId or restores an archived document if no revisionId is passed.

HTTP request & arguments

https://www.getoutline.com/api/documents.restore

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredDocument ID or URI identifier
revisionIdoptionalRevision ID to restore to

documents.pin Pin a document

Pins a document to the collection home. The pinned document is visible to all members of the team.

HTTP request & arguments

https://www.getoutline.com/api/documents.pin

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredDocument ID or URI identifier

documents.unpin Unpin a document

Unpins a document from the collection home. It will still remain in the collection itself.

HTTP request & arguments

https://www.getoutline.com/api/documents.unpin

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredDocument ID or URI identifier

documents.star Star a document

Star (favorite) a document for authenticated user.

HTTP request & arguments

https://www.getoutline.com/api/documents.star

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredDocument ID or URI identifier

documents.unstar Unstar a document

Unstar a starred (favorited) document for authenticated user.

HTTP request & arguments

https://www.getoutline.com/api/documents.unstar

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredDocument ID or URI identifier

documents.viewed Get recently viewed document for user

Return recently viewed documents for the authenticated user

HTTP request & arguments

https://www.getoutline.com/api/documents.viewed

ArgumentRequiredDescription
tokenrequiredAuthentication token
offsetoptionalPagination offset
limitoptionalPagination limit

documents.starred Get recently starred document for user

Return recently starred documents for the authenticated user

HTTP request & arguments

https://www.getoutline.com/api/documents.starred

ArgumentRequiredDescription
tokenrequiredAuthentication token
offsetoptionalPagination offset
limitoptionalPagination limit

documents.pinned Get pinned documents for a collection

Return pinned documents for a collection

HTTP request & arguments

https://www.getoutline.com/api/documents.pinned

ArgumentRequiredDescription
tokenrequiredAuthentication token
offsetoptionalPagination offset
limitoptionalPagination limit

documents.revision Get revision for a document

Return a specific revision of a document.

HTTP request & arguments

https://www.getoutline.com/api/documents.revision

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredDocument ID or URI identifier
revisionIdrequiredRevision ID

documents.revisions Get revisions for a document

Return revisions for a document. Upon each edit, a new revision is stored.

HTTP request & arguments

https://www.getoutline.com/api/documents.revisions

ArgumentRequiredDescription
tokenrequiredAuthentication token
offsetoptionalPagination offset
limitoptionalPagination limit
idrequiredDocument ID or URI identifier

shares.list List shared document links

List all your currently shared document links.

HTTP request & arguments

https://www.getoutline.com/api/shares.list

ArgumentRequiredDescription
tokenrequiredAuthentication token
offsetoptionalPagination offset
limitoptionalPagination limit

shares.create Create a share link

Creates a new share link that can be used by anyone to access a document. If you request multiple shares for the same document with the same user the same share will be returned.

HTTP request & arguments

https://www.getoutline.com/api/shares.create

ArgumentRequiredDescription
tokenrequiredAuthentication token
documentIdrequiredDocument ID

shares.revoke Revoke a share link

Makes the share link inactive so that it can no longer be used to access the document.

HTTP request & arguments

https://www.getoutline.com/api/shares.revoke

ArgumentRequiredDescription
tokenrequiredAuthentication token
idrequiredShare ID

views.list List document views

List all users that have viewed a document and the overall view count.

HTTP request & arguments

https://www.getoutline.com/api/views.list

ArgumentRequiredDescription
tokenrequiredAuthentication token
documentIdrequiredDocument ID

views.create Create a document view

Creates a new view for a document. This is documented in the interests of thoroughness however it is recommended that views are not created from outside of the Outline UI.

HTTP request & arguments

https://www.getoutline.com/api/views.create

ArgumentRequiredDescription
tokenrequiredAuthentication token
documentIdrequiredDocument ID