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
OAuth2clientCredentialsRequired
Token URL:

OAuth2authorizationCodeRequired
Authorization URL: Token URL: Refresh URL:
Path parameters
invitation_idstring · uuidRequired
Responses
chevron-right
200

Successful Response

application/json

Pending invitation model.

idstring · uuidRequired
organization_namestringRequired
organization_logo_urlany ofOptional
stringOptional
or
nullOptional
organization_member_countintegerRequired
inviting_user_nameany ofOptional
stringOptional
or
nullOptional
inviting_user_avatar_urlany ofOptional
stringOptional
or
nullOptional
expiration_datestring · date-timeRequired
get
/invitations/{invitation_id}

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.

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

Authorizations
OAuth2clientCredentialsRequired
Token URL:

OAuth2authorizationCodeRequired
Authorization URL: Token URL: Refresh URL:
Path parameters
invitation_idstring · uuidRequired
Query parameters
acceptbooleanRequired
Responses
chevron-right
200

Successful Response

application/json
string · uuidOptional
or
nullOptional
post
/invitations/{invitation_id}

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
OAuth2clientCredentialsRequired
Token URL:

OAuth2authorizationCodeRequired
Authorization URL: Token URL: Refresh URL:
Responses
chevron-right
200

Successful Response

application/json

Pending invitation model.

idstring · uuidRequired
organization_namestringRequired
organization_logo_urlany ofOptional
stringOptional
or
nullOptional
organization_member_countintegerRequired
inviting_user_nameany ofOptional
stringOptional
or
nullOptional
inviting_user_avatar_urlany ofOptional
stringOptional
or
nullOptional
expiration_datestring · date-timeRequired
get
/invitations
200

Successful Response

ZenML Scarf

Last updated

Was this helpful?