For the complete documentation index, see llms.txt. This page is also available as Markdown.

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
200

Successful Response

application/json

Pending invitation model.

idstring · uuidRequired
organization_namestringRequired
organization_logo_urlstring · nullableOptional
organization_member_countintegerRequired
inviting_user_namestring · nullableOptional
inviting_user_avatar_urlstring · nullableOptional
expiration_datestring · date-timeRequired
get/invitations/{invitation_id}
GET /invitations/{invitation_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
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": "2026-01-01T00:00:00.000Z"
}

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
200

Successful Response

application/json
string · uuid · nullableOptional
post/invitations/{invitation_id}
POST /invitations/{invitation_id}?accept=true HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
123e4567-e89b-12d3-a456-426614174000

List Pending Invitations Endpoint

get

List pending invitations for the authenticated user.

Args: offset: Offset for pagination. limit: Limit for pagination (max 100). user: The authenticated user. invitation_manager: Invitation manager.

Returns: List of pending invitations.

Authorizations
OAuth2clientCredentialsRequired
Token URL:

OAuth2authorizationCodeRequired
Authorization URL: Token URL: Refresh URL:
Query parameters
offsetintegerOptionalDefault: 0
limitinteger · min: 1 · max: 100OptionalDefault: 20
Responses
200

Successful Response

application/json

Pending invitation model.

idstring · uuidRequired
organization_namestringRequired
organization_logo_urlstring · nullableOptional
organization_member_countintegerRequired
inviting_user_namestring · nullableOptional
inviting_user_avatar_urlstring · nullableOptional
expiration_datestring · date-timeRequired
get/invitations
GET /invitations HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
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": "2026-01-01T00:00:00.000Z"
  }
]
ZenML Scarf

Last updated

Was this helpful?