Permission Levels
Full control over the workspace, including deletion and collaborator management
Can modify workspace content, invite collaborators, and create share links
Read-only access to workspace content
Collaborator Object
Unique identifier for the collaborator relationship (UUID)
ID of the workspace
ID of the collaborating user
Permission level:
owner, editor, or viewerISO 8601 timestamp when collaboration was created
ISO 8601 timestamp when collaborator last opened the workspace
Collaborator’s display name
Collaborator’s email address
Collaborator’s profile image URL
List Collaborators
Get all collaborators for a workspace, including the owner and any pending invites.Path Parameters
The workspace ID (UUID)
Response
Array of collaborator objects, including the workspace owner
Array of pending invite objects for users who haven’t accepted yet
Invite Collaborator
Invite a user to collaborate on a workspace. If the user exists in the system, they are added immediately and receive a notification email. If the user doesn’t exist, a pending invite is created and sent via email.Path Parameters
The workspace ID (UUID)
Request Body
Email address of the user to invite
Permission level to grant. Options:
editor (default), viewerResponse (Existing User)
When inviting an existing user, they are added immediately.Response (New User)
When inviting a user who doesn’t have an account, a pending invite is created.Only workspace owners and editors can invite collaborators. Pending invites expire after 7 days.
Update Collaborator Permission
Update a collaborator’s permission level.Path Parameters
The workspace ID (UUID)
The collaborator relationship ID (UUID)
Request Body
New permission level. Options:
editor, viewerResponse
Remove Collaborator
Remove a collaborator from a workspace.Path Parameters
The workspace ID (UUID)
The collaborator relationship ID (UUID)
Response
Revoke Invite
Revoke a pending invite before it’s accepted.Path Parameters
The workspace ID (UUID)
The invite ID (UUID)
Response
Create Share Link
Generate a shareable link that allows anyone with the link to join the workspace.Path Parameters
The workspace ID (UUID)
Response
The unique share token
The complete shareable URL
Share links expire after 7 days. If a share link already exists and hasn’t expired, the existing link is returned. If it has expired, a new link is generated.
Only workspace owners and editors can create share links. Users who join via share link receive editor permissions by default.
Access Control
Access to workspace endpoints is controlled based on permission levels:| Endpoint | Owner | Editor | Viewer |
|---|---|---|---|
| List collaborators | ✓ | ✓ | ✓ |
| Invite collaborator | ✓ | ✓ | ✗ |
| Update permission | ✓ | ✗ | ✗ |
| Remove collaborator | ✓ | ✗ | ✗ |
| Create share link | ✓ | ✓ | ✗ |
| Revoke invite | ✓ | ✓ | ✗ |
| Append events | ✓ | ✓ | ✗ |
| Read events | ✓ | ✓ | ✓ |
| Update workspace metadata | ✓ | ✗ | ✗ |
| Delete workspace | ✓ | ✗ | ✗ |