Outline

App · 13 actions

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.

Actions

ActionWhat it does
Archive documentTake a document out of its collection without deleting it.
Change documentChange a document's title or text, or add to its start or end, such as for a running log.
Comment on documentAdd a comment to a document, in Markdown.
Create collectionMake a collection, shared with the whole workspace unless it's private.
Create documentWrite a document in a collection, in Markdown, published or as your draft.
Delete collectionDelete a collection and every document in it.
Delete documentMove a document to the trash, where Outline keeps it for 30 days.
Get documentGet one document, with its text in Markdown.
Get my accountGet who the key acts as, and in which workspace.
List collectionsList the collections the key can see.
List documentsList documents, in every collection or one, recently changed first or by title.
Restore documentBring back an archived document, or one in the trash.
Search documentsFind documents by words in their title or text, best match first, with a snippet of each.

Archive document

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

Inputs

DocumentdocumenttextRequired
The document's ID, from 'Create document' or 'Search documents', or its link.

Outputs

archivedtrue/false
True if it's archived
collection_idtext
The collection it's in
created_attext
When it was made (ISO 8601)
created_bytext
Who wrote it
idtext
The document's ID
linktext
Its link
parent_document_idtext
The document it's nested under, if any
publishedtrue/false
False for a draft only its author sees
texttext
Its text, in Markdown
titletext
Its title
updated_attext
When it last changed (ISO 8601)
updated_bytext
Who last changed it
url_idtext
The short ID at the end of its link
Example output
{
  "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

DocumentdocumenttextRequired
The document's ID, from 'Create document' or 'Search documents', or its link.
Titletitletext
A new title. Leave empty to keep it.
Texttexttext
Text in Markdown. Leave empty to keep the text as it is.
Text goesedit_modetext
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.
Publishpublishtrue/false
Publish a draft. Off leaves it as it is.Default: false.

Outputs

archivedtrue/false
True if it's archived
collection_idtext
The collection it's in
created_attext
When it was made (ISO 8601)
created_bytext
Who wrote it
idtext
The document's ID
linktext
Its link
parent_document_idtext
The document it's nested under, if any
publishedtrue/false
False for a draft only its author sees
texttext
Its text, in Markdown
titletext
Its title
updated_attext
When it last changed (ISO 8601)
updated_bytext
Who last changed it
url_idtext
The short ID at the end of its link
Example output
{
  "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

DocumentdocumenttextRequired
The document's ID, from 'Create document' or 'Search documents', or its link.
CommenttexttextRequired
What to say, in Markdown.

Outputs

created_attext
When (ISO 8601)
document_idtext
The document
idtext
The comment's ID
texttext
What it says
Example output
{
  "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

NamenametextRequired
The collection's name.
Descriptiondescriptiontext
What it's for.
Privateprivatetrue/false
Only you, and people you add in Outline, can see it. Off by default.Default: false.

Outputs

descriptiontext
Its description
idtext
The collection's ID
linktext
Its link
nametext
Its name
privatetrue/false
True if only its members can see it
Example output
{
  "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

CollectioncollectiontextRequired
The collection to put it in.
TitletitletextRequired
The document's title.
Texttexttext
What it says, in Markdown.
Nest underparent_documenttext
A document to put it under, in the same collection.
Publishpublishtrue/false
Publish it for the collection to see. Off keeps it as your draft. On by default.Default: true.

Outputs

archivedtrue/false
True if it's archived
collection_idtext
The collection it's in
created_attext
When it was made (ISO 8601)
created_bytext
Who wrote it
idtext
The document's ID
linktext
Its link
parent_document_idtext
The document it's nested under, if any
publishedtrue/false
False for a draft only its author sees
texttext
Its text, in Markdown
titletext
Its title
updated_attext
When it last changed (ISO 8601)
updated_bytext
Who last changed it
url_idtext
The short ID at the end of its link
Example output
{
  "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

CollectioncollectiontextRequired
The collection to delete.

Outputs

deletedtrue/false
True once deleted
idtext
The collection
Example output
{
  "deleted": true,
  "id": "2f4c6e8a-1b3d-4f5a-8c7e-9d0b1a2c3e4f"
}

Delete document

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

Inputs

DocumentdocumenttextRequired
The document's ID, from 'Create document' or 'Search documents', or its link.

Outputs

deletedtrue/false
True once deleted
idtext
The document
Example output
{
  "deleted": true,
  "id": "9bcb3a6e-7a2b-4c1e-9f3d-5a6b7c8d9e0f"
}

Get document

Get one document, with its text in Markdown.

Inputs

DocumentdocumenttextRequired
The document's ID, from 'Create document' or 'Search documents', or its link.

Outputs

archivedtrue/false
True if it's archived
collection_idtext
The collection it's in
created_attext
When it was made (ISO 8601)
created_bytext
Who wrote it
idtext
The document's ID
linktext
Its link
parent_document_idtext
The document it's nested under, if any
publishedtrue/false
False for a draft only its author sees
texttext
Its text, in Markdown
titletext
Its title
updated_attext
When it last changed (ISO 8601)
updated_bytext
Who last changed it
url_idtext
The short ID at the end of its link
Example output
{
  "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_emailtext
Your email address
user_nametext
Your name
workspacetext
The workspace's name
workspace_urltext
The workspace's address
Example output
{
  "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

collectionslist
The collections
countnumber
How many
Example output
{
  "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

Collectioncollectiontext
Only documents in this collection.
Ordersorttext
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 manylimitnumber
How many documents. Defaults to 25.From 1 to 500.

Outputs

countnumber
How many
documentslist
The documents
Example output
{
  "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

DocumentdocumenttextRequired
The document's ID, from 'Create document' or 'Search documents', or its link.

Outputs

archivedtrue/false
True if it's archived
collection_idtext
The collection it's in
created_attext
When it was made (ISO 8601)
created_bytext
Who wrote it
idtext
The document's ID
linktext
Its link
parent_document_idtext
The document it's nested under, if any
publishedtrue/false
False for a draft only its author sees
texttext
Its text, in Markdown
titletext
Its title
updated_attext
When it last changed (ISO 8601)
updated_bytext
Who last changed it
url_idtext
The short ID at the end of its link
Example output
{
  "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 forquerytextRequired
The words to look for.
Collectioncollectiontext
Only documents in this collection.
How manylimitnumber
How many documents. Defaults to 25.From 1 to 500.

Outputs

countnumber
How many
documentslist
The documents, best match first
Example output
{
  "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"
    }
  ]
}

On this page