Slug

string

document slug

Match pattern:^[\w-]+$

<= 80 characters

Example

PublishStatus

string

Allowed values:publishedunpublished

Document

object

a document

idstring(uuid)required

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

statusstringrequired

Allowed values:publishedunpublished

parent_document_idstring(uuid)required

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

slugstringrequired

document slug

Match pattern:^[\w-]+$

<= 80 characters

Example:path-for-seo

created_atstring(date-time)required

Example:2023-01-11T02:30:42.227Z

modified_atstring(date-time)required

Example:2023-01-11T02:30:42.227Z

revisionobjectrequired

revision of a document

Show Child Parameters
Example

GetManyDocumentTrees

object
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

a document tree

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
slugstringrequired

document slug

Example:path-for-seo

metadataobjectrequired

metadata of the document

Example:{"author":"John Doe"}

statusstringrequired

Allowed values:publishedunpublished

childrenarray[object]required

a document tree

Example:{"id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","title":"Hello world","status":"published","slug":"hello-world","metadata":{"author":"John Doe"},"children":[]}

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