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 Comments API

`Comments` represent a comment either on a selection of text in a documentor on the document itself.

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

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

This API exposes 5 operations across 5 paths, and defines 8 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.

5 operations 5 paths 8 schemas 5 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 Comments 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 5

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

Comments 5

Comments represent a comment either on a selection of text in a document or on the document itself.

POST
/comments.create
Create a comment
commentsCreate body → 200401403404429
POST
/comments.info
Retrieve a comment
commentsInfo body → 200401403404429
POST
/comments.update
Update a comment
commentsUpdate body → 200401403404429
POST
/comments.delete
Delete a comment
commentsDelete body → 200401403404429
POST
/comments.list
List all comments
commentsList body → 200401403429

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Comment (13 properties), User (12 properties), Error (5 properties), Sorting (2 properties). Each schema is shown below with its type and property counts.

Error
object
5 properties
User
object
12 properties
UserRole
string
Policy
object
2 properties
Sorting
object
2 properties
Pagination
object
2 properties
Ability
A single permission granted by a policy
Comment
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

outline-comments-api-openapi.yml Raw ↑

Other APIs Outline publishes across the network.

Outline AccessRequests API
Outline Attachments API
Outline Auth API
Outline Collections API
Outline DataAttributes API
Outline Documents 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 Comments 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.