PageMeta

object

Contains pagination query parameters and the total number of objects returned.

numbernumberrequired

Example:1

sizenumberrequired

Example:10

totalnumberrequired

Example:100

Example

PaginatedMeta

object

returns the pagination information

pageobjectrequired

Contains pagination query parameters and the total number of objects returned.

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

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

DocumentItemWithStatus

Example

ListDocumentsWithStatus

object
* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarrayrequired
* Additional properties are NOT allowed.
Example