Documents
document operations
List collection documents
List documents in a collection
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
A field to filter on. Supported fields: slug, metadata.
Example:filter[name]=my-doc
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Response
Response
Documents in the collection
ListDocuments
returns the pagination information
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Get a document by slug
Get a document. Will be removed after
Query Parameters
Unique slug of the document.
Example:/about/company
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Response
application/json
Response
Document
Document
a 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
revision of a document
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
Authentication
Path Parameters
Query Parameters
Get the document
Get the document
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Targeted document
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Headers
Allowed values:text/markdownapplication/jsonapplication/vnd.konnect.document-nodes+json
Default:application/json
Response
Response
Document
Document
a 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
revision of a document
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
Authentication
Path Parameters
Headers
ListDocumentsTree
objectreturns the pagination information
Show Child Parameters
a document tree