Get Document Tree
get the document tree
Path Parameters
Kind of the Konnect resource
Allowed values:services
Example:services
Id of the Konnect resource
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Response
application/json
Response
Tree of documents
a 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
the metadata of the document
Example:{"author":"Jane Doe","description":"This is a description","keywords":"hello, world"}
a document tree
Show Child Parameters
Authentication
Path Parameters
Get Document by ID
get the document by its id
Path Parameters
Kind of the Konnect resource
Allowed values:services
Example:services
Id of the Konnect resource
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
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
Authentication
Path Parameters
Headers
Get Document by Slug
get the document by its slug
Path Parameters
Kind of the Konnect resource
Allowed values:services
Example:services
Id of the Konnect resource
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
slug of the document
Example:getting-started
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
Authentication
Path Parameters
Headers
ResourceKind
stringAllowed values:services
HasDocumentationRequestPayload
objectAllowed values:services
>= 1 items<= 100 items