How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Outline Documents API

`Documents` are what everything else revolves around. A document representsa single page of information and always returns the latest version of thecontent. Documents are stored in [Markdown](https://spec.commonmark.org/)formatting.

Outline Documents API is one of 18 APIs that Outline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 30 operations across 30 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 2 base URLs: https://app.getoutline.com/api, https://{domain}/api.

30 operations 30 paths 19 schemas 30 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://app.getoutline.com/api
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Outline Documents API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 2 scopes. By default, every request must be authenticated.

Paths & Operations 30

Across 30 paths, the API surfaces 30 operations — 30 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 30

Documents are what everything else revolves around. A document represents a single page of information and always returns the latest version of the content. Documents are stored i…

POST
/documents.info
Retrieve a document
documentsInfo body → 200401403404429
POST
/documents.insights
Retrieve insights for a document
documentsInsights body → 200400401403404429
POST
/documents.import
Import a file as a document
documentsImport body → 200401403404429
POST
/documents.export
Export a document.
documentsExport body → 200401403404429
POST
/documents.list
List all documents
documentsList body → 200401403429
POST
/documents.documents
Retrieve a document's child structure
documentsDocuments body → 200401403404429
POST
/documents.drafts
List all draft documents
documentsDrafts body → 200401403429
POST
/documents.viewed
List all recently viewed documents
documentsViewed body → 200401403429
POST
/documents.answerQuestion
Query documents with natural language
documentsAnswerQuestion body → 200401403429
POST
/documents.search_titles
Search document titles
documentsSearchTitles body → 200401403429
POST
/documents.search
Search all documents
documentsSearch body → 200401403429
POST
/documents.create
Create a document
documentsCreate body → 200400401403429
POST
/documents.update
Update a document
documentsUpdate body → 200400401403404429
POST
/documents.templatize
Create a template from a document
documentsTemplatize body → 200400401403429
POST
/documents.unpublish
Unpublish a document
documentsUnpublish body → 200400401403404429
POST
/documents.move
Move a document
documentsMove body → 200400401403404429
POST
/documents.archive
Archive a document
documentsArchive body → 200400401403404429
POST
/documents.restore
Restore a document
documentsRestore body → 200400401403404429
POST
/documents.delete
Delete a document
documentsDelete body → 200400401403404429
POST
/documents.users
List document users
documentsUsers body → 200400401403404429
POST
/documents.memberships
List document memberships
documentsMemberships body → 200400401403404429
POST
/documents.add_user
Add a document user
documentsAddUser body → 200400401403404429
POST
/documents.remove_user
Remove a document user
documentsRemoveUser body → 200400401403404429
POST
/documents.archived
List all archived documents
documentsArchived body → 200401403429
POST
/documents.deleted
List all deleted documents
documentsDeleted body → 200401403429
POST
/documents.duplicate
Duplicate a document
documentsDuplicate body → 200400401403404429
POST
/documents.add_group
Add a group to a document
documentsAddGroup body → 200400401403404429
POST
/documents.remove_group
Remove a group from a document
documentsRemoveGroup body → 200400401403404429
POST
/documents.group_memberships
List document group memberships
documentsGroupMemberships body → 200400401403404429
POST
/documents.empty_trash
Empty trash
documentsEmptyTrash → 200401403429

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Document (23 properties), Collection (20 properties), Template (15 properties), User (12 properties). Each schema is shown below with its type and property counts.

TextEditMode
string
The editing mode for text updates to a document. When set to patch, the findText parameter is required and the existing occurrence of findText will be replaced…
Collection
object
20 properties
User
object
12 properties
UserRole
string
DocumentInsight
object
A rollup of activity counts for a document over a daily or weekly period.
8 properties
DocumentDataAttribute
object
3 properties
Pagination
object
2 properties
Membership
object
8 properties
CollectionGroupMembership
object
6 properties
Error
object
5 properties
Permission
string
Policy
object
2 properties
Document
object
23 properties
NavigationNode
object
4 properties
Ability
A single permission granted by a policy
Group
object
9 properties
Template
object
15 properties
Sorting
object
2 properties
SearchResult
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

outline-documents-api-openapi.yml Raw ↑

Other APIs Outline publishes across the network.

Outline AccessRequests API
Outline Attachments API
Outline Auth API
Outline Collections API
Outline Comments API
Outline DataAttributes API
Outline Events API
Outline FileOperations API
Outline Groups API
Outline OAuthAuthentications API
Outline OAuthClients API
Outline Revisions API
Where this information came from

This is an independent, third-party profile of Outline Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.