Get Workspace Invite Details

View as Markdown

Retrieve details of a workspace invite using its token (public endpoint)

Path parameters

tokenstringRequiredformat: "uuid"

Response

Invite details retrieved
emailstringRead-onlyformat: "email"
Email address of the person being invited
workspace_namestringRead-only
workspace_idintegerRead-only
workspace_descriptionstringRead-only
inviterobject
Simple user serializer with profile picture from associated IAMUserDetail. Fields: - id, email, full_name, username, is_verified (from IAMUser) - profile_picture (from first related IAMUserDetail if present)
inviter_namestringRead-only
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

is_expiredbooleanRead-only

Check if invite is expired.

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

Returns: bool: True if the invite is expired, False otherwise

expires_atdatetimeRead-only
When this invite expires
messagestringRead-only
Optional message from the inviter
statusenum
Current status of the invitation * `pending` - Pending * `accepted` - Accepted * `cancelled` - Cancelled * `expired` - Expired
Allowed values:

Errors

404
Not Found Error