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

Document item

object
* Additional properties are NOT allowed.
idstring(uuid)required

the id of the document

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

parent_document_idstring(uuid)required

the id of the parent document

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

slugstringrequired

the slug of the document

Example:getting-started

titlestringrequired

the title of the document

Example:Getting Started

filenamestringrequired

the filename of the document

Example:myDocument.md

statusstringrequired

document publish status. Default to published.

Allowed values:publishedunpublished

metadataobjectrequired

Contains key value pairs information about entity’s metadata.

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

* Additional properties are allowed.
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

Document

object

a document

idstring(uuid)required

the id of the document

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

parent_document_idstring(uuid)

the id of the parent document

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

slugstringrequired

the slug of the document

Example:getting-started

statusstringrequired

document publish status. Default to published.

Allowed values:publishedunpublished

revisionobjectrequired

revision of a document

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

Revision

object

revision of a document

idstring(uuid)required

the id of the revision

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

document_idstring(uuid)required

the id of the document

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

contentstringrequired

Markdown document

metadataobjectrequired

Contains key value pairs information about entity’s metadata.

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

* Additional properties are allowed.
titlestringrequired

the title of the document

Example:Hello World

Example

Slug

string

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example