ListCollectionResponse
objectreturns the pagination information
Show Child Parameters
a document collection
Show Child Parameters
Document Collection
objecta document collection
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Example:my document collection
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
Document
objecta document
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
document publish status. Default to published.
Allowed values:publishedunpublished
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 of a document
Show Child Parameters
DocumentParsed
objectShow Child Parameters
DocumentTree
objecta document tree
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
Example:myDocument.md
document slug
Example:path-for-seo
Contains key value pairs information about entity’s metadata.
Example:{"owner":"John Appleseed"}
document publish status. Default to published.
Allowed values:publishedunpublished
a document tree
Example:{"id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","title":"Hello world","filename":"myDocument.md","slug":"hello-world","status":"published","created_at":"2023-01-11T02:30:42.227Z","updated_at":"2023-01-11T02:30:42.227Z","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