API documentation — Outline

Cited by

Facts read from this source

• API rpc style Report an error

  “The Outline API is structured in an RPC style. It enables you to programatically interact with all aspects of Outline’s data – in fact, the main application is built on exactly the same API.”

• Openapi spec Report an error

  “The API structure is available as an openapi specification if that’s your jam – it can be used to generate clients for most programming languages.”

• API endpoint https only Report an error

  “Outline’s API follows simple RPC style conventions where each API endpoint is a POST method on https://app.getoutline.com/api/:method. Only HTTPS is supported and all response payloads are JSON.”

• API key management Report an error

  “You can create new API keys under Settings => API & Apps.”

• API key auth header Report an error

  “To authenticate with API, you should supply the API key as a "Bearer" token in the Authorization header (Authorization: Bearer YOUR_API_KEY).”

• API key format Report an error

  “All API keys always begin with ol_api_ followed by a random string of 38 letters and numbers.”

• Oauth2 Report an error

  “Register your application under Settings => Applications Obtain an access token by exchanging the client credentials for an access token Use the access token to authenticate requests to the API”

• API scopes Report an error

  “Scopes are used to limit the access of an API key or application to specific resources. For example, an application may only need access to read documents, but not write them.”

• API rate limits Report an error

  “Like most APIs, Outline has rate limits in place to prevent abuse. Endpoints that mutate data are more restrictive than read-only endpoints. If you exceed the rate limit for a given endpoint, you will receive a 429 Too Many Requests status code.”

• API policies Report an error

  “Most API resources have associated "policies", these objects describe the current authentications authorized actions related to an individual resource.”

• API client libraries Report an error

  “Client Libraries Shell Ruby Node.js PHP Python”

4 facts read from this page are not shown because they could not be confirmed on the page as captured.

Scores citing this record

• The Engineering Lead Help-center publishing & integrations
• The IT Administrator Help-center publishing & integrations
• The Operations Lead Help-center publishing & integrations
• The Quality Manager Help-center publishing & integrations
• The Skeptic Help-center publishing & integrations
• The Skeptic Import, export & self-hosting
• The Support Knowledge Manager Help-center publishing & integrations
• The Support Knowledge Manager Import, export & self-hosting