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:
or
nullOptional
or
string · enumOptionalPossible values:

The Collection object

{
  "object": "collection",
  "id": "text",
  "title": "text",
  "description": "text",
  "organization": "text",
  "parent": "text",
  "defaultLevel": "admin",
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com"
  },
  "permissions": {
    "view": true,
    "admin": true,
    "viewInviteLinks": true,
    "create": true
  }
}

Last updated

Was this helpful?

Powered by GitBook