invites

List Workspace Invites

View as Markdown

List all invites for a workspace. Uses current workspace context if available, otherwise requires workspace_id parameter.

Query parameters

statusstringOptional

Filter by invite status (pending, accepted, cancelled, expired)

workspace_idintegerOptional

ID of the workspace to list invites for (optional if workspace context is set)

Response

List of invites
idintegerRead-only
tokenstringRead-onlyformat: "uuid"
Unique token for invite identification
emailstringformat: "email"<=254 characters
Email address of the person being invited
role_displaystringRead-only

Get human-readable role name.

Args: obj: The model instance being serialized (typically WorkspaceInvite)

Returns: str: The human-readable role name, or “UNKNOWN” if not found

statusenum

Current status of the invitation

  • pending - Pending
  • accepted - Accepted
  • cancelled - Cancelled
  • expired - Expired
Allowed values:
created_atdatetimeRead-only
expires_atdatetimeRead-only
When this invite expires
accepted_atdatetime or nullRead-only
When the invite was accepted
invited_by_emailstringRead-onlyformat: "email"
invited_by_usernamestringRead-only
workspace_namestringRead-only
roleenum

Role to assign when invite is accepted

  • 1 - Viewer
  • 2 - Editor
  • 3 - Admin
  • 4 - Owner
Allowed values:
messagestring
Optional message from the inviter

Errors

400
Bad Request Error
403
Forbidden Error