All enumeration types used across the API.
WorkspaceRole
Hierarchical role system with 5 levels. Higher levels inherit all permissions of lower levels.
| Role | Level | Description |
|---|
OWNER | 5 | Full control, transfer ownership, delete workspace |
ADMIN | 4 | Manage members, invite/remove members, manage invitations |
EDITOR | 3 | Create, edit, delete, and move documents |
COMMENTER | 2 | View documents and add comments |
VIEWER | 1 | View documents only (read-only) |
Permission Matrix
| Action | VIEWER | COMMENTER | EDITOR | ADMIN | OWNER |
|---|
| View documents | Yes | Yes | Yes | Yes | Yes |
| Add comments | - | Yes | Yes | Yes | Yes |
| Create/edit documents | - | - | Yes | Yes | Yes |
| Delete documents | - | - | Yes | Yes | Yes |
| Move documents | - | - | Yes | Yes | Yes |
| Publish/unpublish | - | - | Yes | Yes | Yes |
| Invite members | - | - | - | Yes | Yes |
| Remove members | - | - | - | Yes | Yes |
| Update member roles | - | - | - | Yes | Yes |
| Update workspace | - | - | - | Yes | Yes |
| Transfer ownership | - | - | - | - | Yes |
| Delete workspace | - | - | - | - | Yes |
NotificationType
| Type | Actionable | Description |
|---|
WORKSPACE_INVITATION | Yes | User was invited to a workspace |
COMMENT_MENTION | No | User was @mentioned in a comment |
COMMENT_REPLY | No | Someone replied to user's comment |
DOCUMENT_SHARED | No | A document was shared with the user |
MEMBER_ADDED | No | User was added to a workspace |
MEMBER_REMOVED | No | User was removed from a workspace |
ROLE_CHANGED | No | User's role was changed |
OWNERSHIP_TRANSFERRED | No | Workspace ownership was transferred |
SYSTEM | No | System notification |
NotificationStatus
| Status | Description |
|---|
UNREAD | Not yet seen by user |
READ | Marked as read |
ACTIONED | User took action (e.g., accepted invitation) |
DISMISSED | User dismissed the notification |
InvitationStatus
| Status | Description |
|---|
PENDING | Invitation sent, awaiting response |
ACCEPTED | Invitation accepted |
DECLINED | Invitation declined |
EXPIRED | Invitation expired |
CANCELLED | Invitation cancelled by admin/owner |
MemberStatus
| Status | Description |
|---|
ACTIVE | Active member |
SUSPENDED | Suspended member |
REMOVED | Removed from workspace |
| Format | Extension | Content-Type |
|---|
PDF | .pdf | application/pdf |
DOCX | .docx | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
MARKDOWN | .md | text/markdown |
User Status
| Status | Description |
|---|
active | Active user |
suspended | Suspended user |
deleted | Deleted user |
| Status | Description |
|---|
open | Thread is active |
resolved | Thread has been resolved |