# Outline

> Keep your Outline wiki up to date: write, change and search documents, keep running logs, comment, and organise collections. Start a workflow when a document is published.

App · 13 actions. Web page: https://docs.lodol.com/docs/integrations/outline

## Actions

### Archive document

Take a document out of its collection without deleting it. 'Restore document' brings it back.

**Inputs**

- Document (`document`, text, required): The document's ID, from 'Create document' or 'Search documents', or its link.

**Outputs**

- `archived` (true/false): True if it's archived
- `collection_id` (text): The collection it's in
- `created_at` (text): When it was made (ISO 8601)
- `created_by` (text): Who wrote it
- `id` (text): The document's ID
- `link` (text): Its link
- `parent_document_id` (text): The document it's nested under, if any
- `published` (true/false): False for a draft only its author sees
- `text` (text): Its text, in Markdown
- `title` (text): Its title
- `updated_at` (text): When it last changed (ISO 8601)
- `updated_by` (text): Who last changed it
- `url_id` (text): The short ID at the end of its link

**Example output**

```json
{
  "archived": true,
  "collection_id": "2f4c6e8a-1b3d-4f5a-8c7e-9d0b1a2c3e4f",
  "created_at": "2026-10-20T09:00:00.000Z",
  "created_by": "Sam Lee",
  "id": "9bcb3a6e-7a2b-4c1e-9f3d-5a6b7c8d9e0f",
  "link": "https://app.getoutline.com/doc/on-call-handbook-hDYep1TPAM",
  "parent_document_id": "",
  "published": true,
  "text": "# On-call\n\nWho to call and when.",
  "title": "On-call handbook",
  "updated_at": "2026-10-28T09:00:00.000Z",
  "updated_by": "Sam Lee",
  "url_id": "hDYep1TPAM"
}
```

### Change document

Change a document's title or text, or add to its start or end, such as for a running log.

**Inputs**

- Document (`document`, text, required): The document's ID, from 'Create document' or 'Search documents', or its link.
- Title (`title`, text): A new title. Leave empty to keep it.
- Text (`text`, text): Text in Markdown. Leave empty to keep the text as it is.
- Text goes (`edit_mode`, text): Whether the text replaces what's there or is added to its end or start. Defaults to replace. One of: `replace` (Replace the text), `append` (Add to the end), `prepend` (Add to the start). Default: `replace`.
- Publish (`publish`, true/false): Publish a draft. Off leaves it as it is. Default: `false`.

**Outputs**

- `archived` (true/false): True if it's archived
- `collection_id` (text): The collection it's in
- `created_at` (text): When it was made (ISO 8601)
- `created_by` (text): Who wrote it
- `id` (text): The document's ID
- `link` (text): Its link
- `parent_document_id` (text): The document it's nested under, if any
- `published` (true/false): False for a draft only its author sees
- `text` (text): Its text, in Markdown
- `title` (text): Its title
- `updated_at` (text): When it last changed (ISO 8601)
- `updated_by` (text): Who last changed it
- `url_id` (text): The short ID at the end of its link

**Example output**

```json
{
  "archived": false,
  "collection_id": "2f4c6e8a-1b3d-4f5a-8c7e-9d0b1a2c3e4f",
  "created_at": "2026-10-20T09:00:00.000Z",
  "created_by": "Sam Lee",
  "id": "9bcb3a6e-7a2b-4c1e-9f3d-5a6b7c8d9e0f",
  "link": "https://app.getoutline.com/doc/on-call-handbook-hDYep1TPAM",
  "parent_document_id": "",
  "published": true,
  "text": "# On-call\n\nWho to call and when.",
  "title": "On-call handbook",
  "updated_at": "2026-10-28T09:00:00.000Z",
  "updated_by": "Sam Lee",
  "url_id": "hDYep1TPAM"
}
```

### Comment on document

Add a comment to a document, in Markdown.

**Inputs**

- Document (`document`, text, required): The document's ID, from 'Create document' or 'Search documents', or its link.
- Comment (`text`, text, required): What to say, in Markdown.

**Outputs**

- `created_at` (text): When (ISO 8601)
- `document_id` (text): The document
- `id` (text): The comment's ID
- `text` (text): What it says

**Example output**

```json
{
  "created_at": "2026-10-28T09:05:00.000Z",
  "document_id": "9bcb3a6e-7a2b-4c1e-9f3d-5a6b7c8d9e0f",
  "id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
  "text": "Looks right"
}
```

### Create collection

Make a collection, shared with the whole workspace unless it's private.

**Inputs**

- Name (`name`, text, required): The collection's name.
- Description (`description`, text): What it's for.
- Private (`private`, true/false): Only you, and people you add in Outline, can see it. Off by default. Default: `false`.

**Outputs**

- `description` (text): Its description
- `id` (text): The collection's ID
- `link` (text): Its link
- `name` (text): Its name
- `private` (true/false): True if only its members can see it

**Example output**

```json
{
  "description": "",
  "id": "2f4c6e8a-1b3d-4f5a-8c7e-9d0b1a2c3e4f",
  "link": "https://app.getoutline.com/collection/engineering-9fsd9H1Ugq",
  "name": "Engineering",
  "private": false
}
```

### Create document

Write a document in a collection, in Markdown, published or as your draft.

**Inputs**

- Collection (`collection`, text, required): The collection to put it in.
- Title (`title`, text, required): The document's title.
- Text (`text`, text): What it says, in Markdown.
- Nest under (`parent_document`, text): A document to put it under, in the same collection.
- Publish (`publish`, true/false): Publish it for the collection to see. Off keeps it as your draft. On by default. Default: `true`.

**Outputs**

- `archived` (true/false): True if it's archived
- `collection_id` (text): The collection it's in
- `created_at` (text): When it was made (ISO 8601)
- `created_by` (text): Who wrote it
- `id` (text): The document's ID
- `link` (text): Its link
- `parent_document_id` (text): The document it's nested under, if any
- `published` (true/false): False for a draft only its author sees
- `text` (text): Its text, in Markdown
- `title` (text): Its title
- `updated_at` (text): When it last changed (ISO 8601)
- `updated_by` (text): Who last changed it
- `url_id` (text): The short ID at the end of its link

**Example output**

```json
{
  "archived": false,
  "collection_id": "2f4c6e8a-1b3d-4f5a-8c7e-9d0b1a2c3e4f",
  "created_at": "2026-10-20T09:00:00.000Z",
  "created_by": "Sam Lee",
  "id": "9bcb3a6e-7a2b-4c1e-9f3d-5a6b7c8d9e0f",
  "link": "https://app.getoutline.com/doc/on-call-handbook-hDYep1TPAM",
  "parent_document_id": "",
  "published": true,
  "text": "# On-call\n\nWho to call and when.",
  "title": "On-call handbook",
  "updated_at": "2026-10-28T09:00:00.000Z",
  "updated_by": "Sam Lee",
  "url_id": "hDYep1TPAM"
}
```

### Delete collection

Delete a collection and every document in it.

**Inputs**

- Collection (`collection`, text, required): The collection to delete.

**Outputs**

- `deleted` (true/false): True once deleted
- `id` (text): The collection

**Example output**

```json
{
  "deleted": true,
  "id": "2f4c6e8a-1b3d-4f5a-8c7e-9d0b1a2c3e4f"
}
```

### Delete document

Move a document to the trash, where Outline keeps it for 30 days.

**Inputs**

- Document (`document`, text, required): The document's ID, from 'Create document' or 'Search documents', or its link.

**Outputs**

- `deleted` (true/false): True once deleted
- `id` (text): The document

**Example output**

```json
{
  "deleted": true,
  "id": "9bcb3a6e-7a2b-4c1e-9f3d-5a6b7c8d9e0f"
}
```

### Get document

Get one document, with its text in Markdown.

**Inputs**

- Document (`document`, text, required): The document's ID, from 'Create document' or 'Search documents', or its link.

**Outputs**

- `archived` (true/false): True if it's archived
- `collection_id` (text): The collection it's in
- `created_at` (text): When it was made (ISO 8601)
- `created_by` (text): Who wrote it
- `id` (text): The document's ID
- `link` (text): Its link
- `parent_document_id` (text): The document it's nested under, if any
- `published` (true/false): False for a draft only its author sees
- `text` (text): Its text, in Markdown
- `title` (text): Its title
- `updated_at` (text): When it last changed (ISO 8601)
- `updated_by` (text): Who last changed it
- `url_id` (text): The short ID at the end of its link

**Example output**

```json
{
  "archived": false,
  "collection_id": "2f4c6e8a-1b3d-4f5a-8c7e-9d0b1a2c3e4f",
  "created_at": "2026-10-20T09:00:00.000Z",
  "created_by": "Sam Lee",
  "id": "9bcb3a6e-7a2b-4c1e-9f3d-5a6b7c8d9e0f",
  "link": "https://app.getoutline.com/doc/on-call-handbook-hDYep1TPAM",
  "parent_document_id": "",
  "published": true,
  "text": "# On-call\n\nWho to call and when.",
  "title": "On-call handbook",
  "updated_at": "2026-10-28T09:00:00.000Z",
  "updated_by": "Sam Lee",
  "url_id": "hDYep1TPAM"
}
```

### Get my account

Get who the key acts as, and in which workspace.

**Inputs**: None.

**Outputs**

- `user_email` (text): Your email address
- `user_name` (text): Your name
- `workspace` (text): The workspace's name
- `workspace_url` (text): The workspace's address

**Example output**

```json
{
  "user_email": "sam@example.com",
  "user_name": "Sam Lee",
  "workspace": "Acme",
  "workspace_url": "https://acme.getoutline.com"
}
```

### List collections

List the collections the key can see.

**Inputs**: None.

**Outputs**

- `collections` (list): The collections
- `count` (number): How many

**Example output**

```json
{
  "collections": [
    {
      "description": "",
      "id": "2f4c6e8a-1b3d-4f5a-8c7e-9d0b1a2c3e4f",
      "link": "https://app.getoutline.com/collection/engineering-9fsd9H1Ugq",
      "name": "Engineering",
      "private": false
    }
  ],
  "count": 1
}
```

### List documents

List documents, in every collection or one, recently changed first or by title.

**Inputs**

- Collection (`collection`, text): Only documents in this collection.
- Order (`sort`, text): How to order them. Defaults to recently changed first. One of: `updatedAt` (Recently changed first), `createdAt` (Newest first), `title` (Title, A to Z). Default: `updatedAt`.
- How many (`limit`, number): How many documents. Defaults to 25. From 1 to 500.

**Outputs**

- `count` (number): How many
- `documents` (list): The documents

**Example output**

```json
{
  "count": 1,
  "documents": [
    {
      "archived": false,
      "collection_id": "2f4c6e8a-1b3d-4f5a-8c7e-9d0b1a2c3e4f",
      "created_at": "2026-10-20T09:00:00.000Z",
      "created_by": "Sam Lee",
      "id": "9bcb3a6e-7a2b-4c1e-9f3d-5a6b7c8d9e0f",
      "link": "https://app.getoutline.com/doc/on-call-handbook-hDYep1TPAM",
      "parent_document_id": "",
      "published": true,
      "title": "On-call handbook",
      "updated_at": "2026-10-28T09:00:00.000Z",
      "updated_by": "Sam Lee",
      "url_id": "hDYep1TPAM"
    }
  ]
}
```

### Restore document

Bring back an archived document, or one in the trash.

**Inputs**

- Document (`document`, text, required): The document's ID, from 'Create document' or 'Search documents', or its link.

**Outputs**

- `archived` (true/false): True if it's archived
- `collection_id` (text): The collection it's in
- `created_at` (text): When it was made (ISO 8601)
- `created_by` (text): Who wrote it
- `id` (text): The document's ID
- `link` (text): Its link
- `parent_document_id` (text): The document it's nested under, if any
- `published` (true/false): False for a draft only its author sees
- `text` (text): Its text, in Markdown
- `title` (text): Its title
- `updated_at` (text): When it last changed (ISO 8601)
- `updated_by` (text): Who last changed it
- `url_id` (text): The short ID at the end of its link

**Example output**

```json
{
  "archived": false,
  "collection_id": "2f4c6e8a-1b3d-4f5a-8c7e-9d0b1a2c3e4f",
  "created_at": "2026-10-20T09:00:00.000Z",
  "created_by": "Sam Lee",
  "id": "9bcb3a6e-7a2b-4c1e-9f3d-5a6b7c8d9e0f",
  "link": "https://app.getoutline.com/doc/on-call-handbook-hDYep1TPAM",
  "parent_document_id": "",
  "published": true,
  "text": "# On-call\n\nWho to call and when.",
  "title": "On-call handbook",
  "updated_at": "2026-10-28T09:00:00.000Z",
  "updated_by": "Sam Lee",
  "url_id": "hDYep1TPAM"
}
```

### Search documents

Find documents by words in their title or text, best match first, with a snippet of each.

**Inputs**

- Search for (`query`, text, required): The words to look for.
- Collection (`collection`, text): Only documents in this collection.
- How many (`limit`, number): How many documents. Defaults to 25. From 1 to 500.

**Outputs**

- `count` (number): How many
- `documents` (list): The documents, best match first

**Example output**

```json
{
  "count": 1,
  "documents": [
    {
      "archived": false,
      "collection_id": "2f4c6e8a-1b3d-4f5a-8c7e-9d0b1a2c3e4f",
      "created_at": "2026-10-20T09:00:00.000Z",
      "created_by": "Sam Lee",
      "id": "9bcb3a6e-7a2b-4c1e-9f3d-5a6b7c8d9e0f",
      "link": "https://app.getoutline.com/doc/on-call-handbook-hDYep1TPAM",
      "parent_document_id": "",
      "published": true,
      "snippet": "Who to call and when",
      "title": "On-call handbook",
      "updated_at": "2026-10-28T09:00:00.000Z",
      "updated_by": "Sam Lee",
      "url_id": "hDYep1TPAM"
    }
  ]
}
```
