ListDocuments

object
* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
Example

DocumentTree

object

a document tree

idstring(uuid)required

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

parent_document_idstring(uuid)

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

titlestringrequired

the title of the document

Example:Getting Started

slugstringrequired

the slug of the document

Example:getting-started

metadataobjectrequired

Contains key value pairs information about entity’s metadata.

Example:{"owner":"John Appleseed"}

* Additional properties are allowed.
childrenarray[object]required

a document tree

Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

ListDocumentsTree

object
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

a document tree

Show Child Parameters
Example

DocumentFormatContentTypeEnum

string

Allowed values:text/markdownapplication/jsonapplication/vnd.konnect.document-nodes+json

Default:application/json

NodeChildren

array

List of children nodes of the current node

One Of
typestringrequired

Allowed values:heading

levelnumber

Level of the heading which maps to HTML tag

>= 1<= 6

childrenOne Of
array[object]

List of children nodes of the current node

HeadingBlockobject
Show Child Parameters