Outline includes a fully featured API structured in an RPC style. It enables you to programmatically interact with all aspects of Outline’s data – in fact, the main application is built on exactly the same API. You can use Outline’s API to build everything from small automations to complete integrations.

Documentation

Detailed documentation and endpoint reference for the API can be found on the developer portal.

Authentication

For personal scripts API keys are the easiest way to access the API – visit Settings → API Keys to create and manage them. To authenticate with API, you can supply the API key as a header (Authorization: Bearer YOUR_API_KEY) or as part of the payload using token parameter. Header based authentication is highly recommended.

API keys can also be further restricted through an expiration date and scope limitations.

Scopes

API keys include the ability to optionally scope their access, you can do so through a space-separated list of endpoints including wildcards. Unscoped API keys will have the same permissions and access as the user that created them.

Some examples of valid scopes: