Create or Update collection
Create or Update the document collection. collectionId must be globally unique. A collectionId of a different kind (service/portal) must not already exist.
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Body
application/json
Body
collection put
Document Collection
a document collection
Example:my document collection
Response
application/json
Response
The document collection has been updated
Document Collection
a document collection
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Example:my document collection
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
Body
Update collection
Update the document collection
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Body
application/json
Body
collection update
UpdateCollectionPayload
payload to update the document collection
Response
application/json
Response
The document collection has been created
Document Collection
a document collection
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Example:my document collection
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
Body
Delete collection
Delete the document collection
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Response
Response
The document collection has been deleted
Authentication
Path Parameters
Documents
document operations
List collection documents
List documents in a collection
Query Parameters
Sorts a collection of documents.
The sort parameter is only applied for ‘application/json’ content-type.
Supported sort attributes are:
- created_at
- updated_at
- slug
- title
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
Filter documents returned in the response.
Show Child Parameters
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Headers
Allowed values:application/jsonapplication/vnd.konnect.document-tree+json
Default:application/json
Response
Response
Documents in the collection
ListDocuments
returns the pagination information