Get Workspace Invite Details

GET

https://host.com/api/v1/invites/:token/

GET

/api/v1/invites/:token/

$ curl /api/v1/invites/token/ \
>      -H "Content-Type: application/json"

1 {
2   "email": "jane.doe@example.com",
3   "workspace_name": "AISquare Studio",
4   "workspace_id": 42,
5   "workspace_description": "Collaborative platform for AI model development and deployment.",
6   "workspace_logo": "https://aisquare.com/assets/logos/aisquare-logo.png",
7   "inviter": {
8     "id": 101,
9     "email": "john.smith@aisquare.com",
10     "full_name": "John Smith",
11     "username": "johnsmith",
12     "is_verified": true,
13     "profile_picture": "https://aisquare.com/profiles/johnsmith.jpg"
14   },
15   "inviter_name": "John Smith",
16   "role_display": "Editor",
17   "is_expired": false,
18   "expires_at": "2024-07-01T23:59:59Z",
19   "message": "Welcome to AISquare Studio! Looking forward to collaborating with you.",
20   "status": "pending"
21 }

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

workspace_logostringRead-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