Document Collection
Document Collection Object
| Field | Type | Description |
|---|---|---|
| id | snowflake | the collection’s unique identifier |
| organisation_id | snowflake | the id of the owning organisation |
| number | integer | the sequential number of the collection within the organisation |
| formatted_number | string | the human‑readable formatted number of the collection |
| name | string | the name of the collection (2‑200 characters) |
| description | string | a longer description of the collection |
| documents | array<document object> | list of documents that belong to this collection |
| count | integer | total number of documents in the collection |
| bookmark | bookmark object? | a bookmark for the current user, if one exists (optional) |
| permissions | object<string, boolean> | map of permission names to booleans indicating what actions are allowed |
| created_at | ISO8601 timestamp | when the collection was created |
| created_by | user object | the user that created the collection (contains only id) |
Document Collection Bookmark User Object
| Field | Type | Description |
|---|---|---|
| organisation_id | snowflake | the id of the organisation in which the collection was bookmarked |
| created_at | ISO8601 timestamp | when the bookmark was created |
| collection_id | snowflake | the id of the bookmarked document collection |
| collection | document collection object | the bookmarked collection; may be a full object or a partial object containing only its id |
| user | user object | the user who created the bookmark (contains only the user id) |
Document Collection Share Object
| Field | Type | Description |
|---|---|---|
| id | snowflake | the share record’s id |
| document_collection | document collection object? | the shared document collection (full object or { "id": "<snowflake>" }) |
| user | user object? | the user that the collection is shared with |
| organisation | organisation object? | the organisation that owns the share |
| type | string | the type of share (e.g., "document_collection") |
| status | string | current status of the share (e.g., "active", "revoked") |
| scope_view | boolean | true if the recipient may view documents in the collection |
| scope_edit | boolean | true if the recipient may edit documents in the collection |
| scope_branch | boolean | true if the recipient may create/modify branches on the collection |
| scope_fork | boolean | true if the recipient may fork documents from the collection |
| scope_revisions | boolean | true if the recipient may view document revisions |
| scope_export | boolean | true if the recipient may export documents from the collection |
| share_to_users_organisation | boolean | true if the share is automatically propagated to all users in the organisation |
| shared_by | user object? | the user who created the share record |
| created_at | ISO8601 timestamp | when the share was created (if the underlying base class provides it) |
| updated_at | ISO8601 timestamp? | when the share was last modified, if applicable |
Document Collection Subscription User Object
| Field | Type | Description |
|---|---|---|
| collection_id | snowflake | the id of the document collection |
| user | user object | the subscribed user (partial object containing only its id) |
| is_sync | boolean | true if this subscription should be synchronised, otherwise false |