Document
objecta document
the id of the document
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
the id of the parent document
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
the slug of the document
Example:getting-started
content of the document
Example:{"type":"document","content":[{"type":"paragraph","content":[{"text":"Hello World","type":"text"}]}]}
Show Child Parameters
the metadata of the document
Example:{"title":"Hello World","description":"This is a description","keywords":"hello, world"}
the title of the document
Example:Hello World
DocumentTree
objecta document tree
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
the title of the document
Example:Getting Started
the slug of the document
Example:getting-started
Contains key value pairs information about entity’s metadata.
Example:{"owner":"John Appleseed"}
a document tree
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
PageMeta
objectContains pagination query parameters and the total number of objects returned.
Example:1
Example:10
Example:100
PaginatedMeta
objectreturns the pagination information
Contains pagination query parameters and the total number of objects returned.
Show Child Parameters
Metadata
objectContains key value pairs information about entity’s metadata.