Download OpenAPI specification:Download
DocumentHub developer Api
List documents in a collection
| collectionId required | string <uuid> Example: bb84c46a-432d-4314-81e4-478614a52dcb Targeted collection |
| page[size] | integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items. |
| page[number] | integer Example: page[number]=1 Determines which page of the entities to retrieve. |
| filter[field] | string Example: filter[field]=filter[name]=my-doc A field to filter on. Supported fields: slug, metadata. |
{- "meta": {
- "page": {
- "number": 1,
- "size": 10,
- "total": 100
}
}, - "data": [
- {
- "id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
- "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
- "slug": "getting-started",
- "title": "Getting Started",
- "metadata": {
- "owner": "John Appleseed"
}, - "created_at": "2022-11-04T20:10:06.927Z",
- "updated_at": "2022-11-04T20:10:06.927Z"
}
]
}Get a document. Will be removed after
| collectionId required | string <uuid> Example: bb84c46a-432d-4314-81e4-478614a52dcb Targeted collection |
| slug required | string Example: slug=/about/company Unique slug of the document. |
{- "id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
- "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
- "slug": "getting-started",
- "revision": {
- "id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
- "document_id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
- "content": "string",
- "metadata": {
- "owner": "John Appleseed"
}, - "title": "Hello World"
}, - "created_at": "2022-11-04T20:10:06.927Z",
- "updated_at": "2022-11-04T20:10:06.927Z"
}Get the document
| collectionId required | string <uuid> Example: bb84c46a-432d-4314-81e4-478614a52dcb Targeted collection |
| documentId required | string <uuid> Example: bb84c46a-432d-4314-81e4-478614a52dcb Targeted document |
| Accept | string (DocumentFormatContentTypeEnum) Default: application/json Enum: "text/markdown" "application/json" "application/vnd.konnect.document-nodes+json" |