Get many documents
Get many documents
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
Path Parameters
Kind of the Konnect resource
Allowed values:services
Example:services
Id of the Konnect resource
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Headers
Allowed values:application/jsonapplication/vnd.konnect.document-tree+json
Default:application/json
Response
Response
Tree of documents or flat list of documents
ListDocumentsWithStatus
returns the pagination information
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Headers
Create document
Create document and associate it with a Konnect resource
Path Parameters
Kind of the Konnect resource
Allowed values:services
Example:services
Id of the Konnect resource
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Body
application/json
Body
document creation
CreateDocumentPayload
a document payload
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug
Match pattern:^[\w-]+$
<= 80 characters
Example:path-for-seo
Allowed values:publishedunpublished
document title
Example:How to create a document in Konnect DocumentHub
Must be a base64 encoded string. Either raw_content or str_mdr_content are required.
Example:YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=
Markdown content. Either raw_content or str_mdr_content are required.
Example:## My Markdown
metadata of the document
Example:{"author":"John Doe"}
name of the uploaded file
Example:my_doc.md
Response
application/json
Response
The document has been created
Document Creation Response Payload
a document payload
document id
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
revision id
Example:ecfb698d-77a8-4ab5-91fa-45ee383b48ba
Authentication
Path Parameters
Body
Get the document
Get the document
Query Parameters
include raw document data in the response
Example:true
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
Response
Response
The document
Document
a document
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Allowed values:publishedunpublished
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug
Match pattern:^[\w-]+$
<= 80 characters
Example:path-for-seo
Example:2023-01-11T02:30:42.227Z
Example:2023-01-11T02:30:42.227Z
revision of a document
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Update the document
Update the document
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
Body
application/json
Body
document update
UpdateDocumentPayload
a document payload
Parent document Id. If this value is explicitly set to null, the
document will be put as a top level document at the bottom of the tree.
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug
Match pattern:^[\w-]+$
<= 80 characters
Example:path-for-seo
Allowed values:publishedunpublished
document title
Example:How to update a document in Konnect DocumentHub
base64 encoded string of the document content
Example:YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=
markdown content
Example:## My Markdown
name of the uploaded file
Example:my_doc.md
Response
application/json
Response
The document has been updated
Document
a document
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Allowed values:publishedunpublished
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug
Match pattern:^[\w-]+$
<= 80 characters
Example:path-for-seo
Example:2023-01-11T02:30:42.227Z
Example:2023-01-11T02:30:42.227Z
revision of a document
Show Child Parameters
Authentication
Path Parameters
Body
Delete the document
Delete the document and all its associated revisions including the saved
files in the datastore. This is a hard delete, files are not recoverable.
Returns 404 if the document cannot be found, 409 if deleting the document would result in other orphaned documents.
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
Response
Response
The document has been deleted