Docs
Open Lodol
DocumentationIntegrationsAPI

Document360

App · Documents · 4 actions

Read and write your Document360 knowledge base: list workspaces and articles, pull an article's content, and create new ones.

Actions

ActionWhat it does
Create an articleCreate a new article in a category.
Get an articleFetch one article translation, including its Markdown body and rendered HTML.
List articlesList the articles in one workspace.
List workspacesList the workspaces (project versions) in your knowledge base.

Create an article

Create a new article in a category. It starts as an unpublished draft.

Inputs

TitletitletextRequired
The article's title. The slug is generated from it.
Category IDcategory_idtextRequired
The ID of the category to create the article in. Find it in the Document360 portal URL when viewing the category.
Workspace IDworkspace_idtextRequired
The ID of the workspace (project version), as returned by List workspaces.
Contentcontenttext
Optional. The article body, as Markdown.
Author IDauthor_idtextRequired
The Document360 team account ID to credit as the article's contributor. Required by Document360's API. Find your own ID in the portal under Settings > Users -- open your account and copy the ID from the URL.

Outputs

article_idtext
Article ID. Use with Get an article.
category_idtext
ID of the category the article was created in
hiddentrue/false
Whether the article is hidden from readers
latest_versionnumber
The newest version number, which may be an unpublished draft
public_versionnumber
The version number readers currently see
slugtext
The article's URL slug
titletext
The article's title
urltext
Link to the article in the published knowledge base
workspace_idtext
ID of the workspace the article belongs to
Example output
{
  "article_id": "7db99386-2816-40f0-991f-174dgdscf",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "hidden": false,
  "latest_version": 2,
  "public_version": 1,
  "slug": "getting-started-with-our-sdk",
  "title": "Getting started with our SDK",
  "url": "https://example.com/v1/docs/en/why-did-we-build-document360",
  "workspace_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234"
}

Get an article

Fetch one article translation, including its Markdown body and rendered HTML.

Inputs

Article IDarticle_idtextRequired
The ID of the article, as returned by List articles.
Language codelanguage_codetext
The language to read, for example 'en' or 'fr'. Defaults to English.Default: en.

Outputs

article_idtext
Article ID. Use with Get an article.
authorslist
The people who have edited the article
category_idtext
ID of the category the article sits in
contenttext
The article body as Markdown source
hiddentrue/false
Whether the article is hidden from readers
html_contenttext
The rendered HTML body, or empty if the article hasn't been rendered
latest_versionnumber
The newest version number, which may be an unpublished draft
public_versionnumber
The version number readers currently see
slugtext
The article's URL slug
titletext
The article's title
urltext
Link to the article in the published knowledge base
version_numbernumber
The version number this response returned
workspace_idtext
ID of the workspace the article belongs to
Example output
{
  "article_id": "7db99386-2816-40f0-991f-174dgdscf",
  "authors": [
    {
      "email": "peterjone@mail.com",
      "name": "Peter Jone"
    }
  ],
  "category_id": "de104b39-db97-4509-8d4c-deeac74d448b",
  "content": "## Install\n\n`npm install @example/sdk`",
  "hidden": false,
  "html_content": "<h2>Install</h2>",
  "latest_version": 2,
  "public_version": 1,
  "slug": "why-did-we-build-document360",
  "title": "Why did we build Document360?",
  "url": "https://example.com/v1/docs/en/why-did-we-build-document360",
  "version_number": 1,
  "workspace_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234"
}

List articles

List the articles in one workspace.

Inputs

Workspace IDworkspace_idtextRequired
The ID of the workspace (project version), as returned by List workspaces.
Language codelanguage_codetext
The language to read, for example 'en' or 'fr'. Defaults to English.Default: en.
Pagepagenumber
Which page of results to return, starting at 1.At least 1. Default: 1.
Articles per pagepage_sizenumber
How many articles to return per page (1-100).From 1 to 100. Default: 25.

Outputs

articleslist
The articles on this page
Example output
{
  "articles": [
    {
      "article_id": "7db99386-2816-40f0-991f-174dgdscf",
      "hidden": false,
      "latest_version": 2,
      "public_version": 1,
      "slug": "why-did-we-build-document360",
      "title": "Why did we build Document360?",
      "url": "https://example.com/v1/docs/en/why-did-we-build-document360"
    }
  ]
}

List workspaces

List the workspaces (project versions) in your knowledge base. Every other action needs a workspace ID from here.

Inputs

None.

Outputs

workspaceslist
The workspaces in the project
Example output
{
  "workspaces": [
    {
      "is_main": true,
      "is_public": true,
      "name": "v1",
      "version_number": 1.0,
      "workspace_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234"
    }
  ]
}

Docker Hub

Previous Page

DocuSeal

Next Page

On this page

ActionsCreate an articleGet an articleList articlesList workspaces