Invitations

Get Invitation Endpoint

get

Get a pending invitation.

Args: invitation_id: ID of the invitation. user: The authenticated user. invitation_manager: Invitation manager.

Returns: The pending invitation.

Authorizations

Path parameters

invitation_idstring · uuidRequired

Responses

get

HTTPcURLJavaScriptPython

GET /invitations/{invitation_id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization_name": "text",
  "organization_logo_url": "text",
  "organization_member_count": 1,
  "inviting_user_name": "text",
  "inviting_user_avatar_url": "text",
  "expiration_date": "2025-04-26T17:46:46.324Z"
}

Respond To Invitation Endpoint

post

Accept or decline a pending invitation.

Args: invitation_id: ID of the invitation. accept: Whether to accept the invitation or not. user: The authenticated user. invitation_manager: Invitation manager.

Raises: HTTPException: If accepting the invitation failed because the organization user limit would be exceeded.

Returns: ID of the organization if the invitation was accepted.

Authorizations

Path parameters

invitation_idstring · uuidRequired

Query parameters

acceptbooleanRequired

Responses

Responsestring · uuid

post

HTTPcURLJavaScriptPython

POST /invitations/{invitation_id}?accept=true HTTP/1.1
Host: 
Accept: */*

123e4567-e89b-12d3-a456-426614174000

List Pending Invitations Endpoint

get

List pending invitations for the authenticated user.

Args: user: The authenticated user. invitation_manager: Invitation manager.

Returns: List of pending invitations.

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /invitations HTTP/1.1
Host: 
Accept: */*

200

Successful Response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organization_name": "text",
    "organization_logo_url": "text",
    "organization_member_count": 1,
    "inviting_user_name": "text",
    "inviting_user_avatar_url": "text",
    "expiration_date": "2025-04-26T17:46:46.324Z"
  }
]