Outline API

https://www.getoutline.com/developers
Admin
The Outline API provides an RPC-style interface for programmatically interacting with all aspects of...
Tokens:1,542
Snippets:24
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### Pagination Response Example

Source: https://www.getoutline.com/developers

Example paginated response for list API methods. Echoes the limit and offset parameters in the pagination key and includes a nextPath shortcut for fetching the next page.

```json
{
  ok: true,
  status: 200,
  data: […],
  pagination: {
    limit: 25,
    offset: 0,
    nextPath: "/api/documents.list?limit=25&offset=25"
  }
}
```

--------------------------------

### Make a POST request with JavaScript fetch

Source: https://www.getoutline.com/developers

Use this JavaScript fetch example to call the Outline API. It sends a POST request with the required headers and parses the JSON response.

```javascript
const response = await fetch("https://app.getoutline.com/api/documents.info", {
  method: "POST",
  headers: {
    Accept: "application/json",
    "Content-Type": "application/json",
    Authorization: "Bearer MY_API_KEY"
  }
})

const body = await response.json();
const document = body.data;

```

--------------------------------

### API Error Response Example

Source: https://www.getoutline.com/developers

Error response format returned when an API request fails. Includes an ok flag set to false and an error message describing the failure.

```json
{
  "ok": false,
  "error": "Not Found"
}
```

--------------------------------

### Make a POST request with cURL

Source: https://www.getoutline.com/developers

Use this cURL command to make a POST request to the Outline API. It requires an API key in the Authorization header and a JSON payload with the document ID.

```bash
curl https://app.getoutline.com/api/documents.info \
-X 'POST' \
-H 'authorization: Bearer MY_API_KEY' \
-H 'content-type: application/json' \
-H 'accept: application/json' \
-d '{"id": "outline-api-NTpezNwhUP"}'

```

--------------------------------

### POST /api/documents.info

Source: https://www.getoutline.com/developers

Retrieves information about a specific document using its identifier.

```APIDOC
## [POST] /api/documents.info

### Description
Fetches information about a document in the workspace.

### Method
POST

### Endpoint
/api/documents.info

### Parameters
#### Request Body
- **id** (string) - Required - The document identifier.

### Request Example
{
  "id": "outline-api-NTpezNwhUP"
}

### Response
#### Success Response (200)
Returns the document data in the response body.

#### Response Example
{
  "data": {}
}

```
Tokens:
Raw