For the complete documentation index, see llms.txt. This page is also available as Markdown.

Collections

Organize and manage grouped sets of spaces for better content structure.

Collections let you bundle multiple spaces under a unified entity, making large-scale content easier to handle. You can sort content by subject, department, or any grouping logic.

The Collection object

Attributes

objectstring · enumRequired

Type of Object, always equals to "collection"

Possible values:

idstringRequired

Unique identifier for the collection

titlestring · max: 50Required

Title of the collection

descriptionstring · max: 100Optional

Description of the collection

organizationstringRequired

ID of the organization owning this collection

parentstringOptional

ID of the parent collection, if any

defaultLevelone ofRequired

Default level for a piece of content

string · enumOptional

"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.

Possible values:

nullOptional

string · enumOptionalPossible values:

The Collection object

Get a collection by its ID

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

collectionIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Responses

200

application/json

objectstring · enumRequired

Type of Object, always equals to "collection"

Possible values:

idstringRequired

Unique identifier for the collection

titlestring · max: 50Required

Title of the collection

descriptionstring · max: 100Optional

Description of the collection

organizationstringRequired

ID of the organization owning this collection

parentstringOptional

ID of the parent collection, if any

defaultLevelone ofRequired

Default level for a piece of content

string · enumOptional

Possible values:

nullOptional

string · enumOptionalPossible values:

get/collections/{collectionId}

200

Delete a collection

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

collectionIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Responses

204

Collection did not exist

205

Collection has been deleted

delete/collections/{collectionId}

No content

Update a collection

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

collectionIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

titlestring · max: 50Optional

Title of the collection

descriptionstring · max: 100Optional

Description of the collection

defaultLevelone ofOptional

Default level for a piece of content

string · enumOptional

Possible values:

nullOptional

string · enumOptionalPossible values:

Responses

200

The collection has been updated

application/json

objectstring · enumRequired

Type of Object, always equals to "collection"

Possible values:

idstringRequired

Unique identifier for the collection

titlestring · max: 50Required

Title of the collection

descriptionstring · max: 100Optional

Description of the collection

organizationstringRequired

ID of the organization owning this collection

parentstringOptional

ID of the parent collection, if any

defaultLevelone ofRequired

Default level for a piece of content

string · enumOptional

Possible values:

nullOptional

string · enumOptionalPossible values:

patch/collections/{collectionId}

200

The collection has been updated

List all collection spaces

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

collectionIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

application/json

countnumberOptional

Total count of objects in the list

get/collections/{collectionId}/spaces

200

Move a collection to a new position.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

collectionIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

parentstring · nullableOptional

The unique id of the parent collection

Responses

200

Collection moved

application/json

objectstring · enumRequired

Type of Object, always equals to "collection"

Possible values:

idstringRequired

Unique identifier for the collection

titlestring · max: 50Required

Title of the collection

descriptionstring · max: 100Optional

Description of the collection

organizationstringRequired

ID of the organization owning this collection

parentstringOptional

ID of the parent collection, if any

defaultLevelone ofRequired

Default level for a piece of content

string · enumOptional

Possible values:

nullOptional

string · enumOptionalPossible values:

400

Invalid position space or collection provided

application/json

404

No matching Collection found for given ID

application/json

409

Operation would not result in any update

application/json

post/collections/{collectionId}/move

Transfer a collection

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

collectionIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

organizationstringRequired

The unique id of the target organization

Responses

200

Collection transferred

application/json

objectstring · enumRequired

Type of Object, always equals to "collection"

Possible values:

idstringRequired

Unique identifier for the collection

titlestring · max: 50Required

Title of the collection

descriptionstring · max: 100Optional

Description of the collection

organizationstringRequired

ID of the organization owning this collection

parentstringOptional

ID of the parent collection, if any

defaultLevelone ofRequired

Default level for a piece of content

string · enumOptional

Possible values:

nullOptional

string · enumOptionalPossible values:

404

No matching Collection found for given ID

application/json

409

Transfer would not result in any update

application/json

412

The collection cannot be moved.

application/json

post/collections/{collectionId}/transfer

List all collections

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

nestedbooleanOptional

If true, all nested collections will be listed

Default: true

Responses

200

application/json

countnumberOptional

Total count of objects in the list

get/orgs/{organizationId}/collections

200

Create a collection

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

titlestring · max: 50Optional

parentstringOptional

ID of a parent collection

Responses

201

Collection created

application/json

post/orgs/{organizationId}/collections

201

Collection created

Last updated 22 hours ago

Was this helpful?