PublishStatus
stringAllowed values:publishedunpublished
Document
objecta document
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Allowed values:publishedunpublished
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug
Match pattern:^[\w-]+$
<= 80 characters
Example:path-for-seo
Example:2023-01-11T02:30:42.227Z
Example:2023-01-11T02:30:42.227Z
revision of a document
Show Child Parameters
GetManyDocumentTrees
objectreturns the pagination information
Show Child Parameters
a document tree
Show Child Parameters
DocumentTree
objecta document tree
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug
Example:path-for-seo
metadata of the document
Example:{"author":"John Doe"}
Allowed values:publishedunpublished
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
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Revision
objectrevision of a document
revision id
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
document id
Example:2272b454-4af6-4c56-8a02-d6145ac62e67
content of the document
Example:{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Hello World","type":"text"}]}]}
Show Child Parameters
Example:{"author":"John Doe"}
Example:Hello world
raw markdown content
Example:I0ludHJvZHVjdGlvbg==
markdown content
Example:## My Markdown
file of the revision