Invitations

List Organization Invitations Endpoint

get

List invitations for the organization.

Args: organization_id: The organization ID. inviting_user_id: Filter by the ID of the inviting user. email: Filter by the email. only_pending: If True, only include pending invitations. offset: Pagination offset. limit: Pagination limit (max 100). user: The authenticated user. rbac: RBAC component. invitation_manager: Invitation manager.

Returns: List of invitations.

Authorizations

OAuth2ComboScheme

OAuth2clientCredentialsRequired

Token URL:

---

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Path parameters

organization_idstring · uuidRequired

Query parameters

inviting_user_idstring · uuid · nullableOptional

emailstring · email · nullableOptional

only_pendingbooleanOptionalDefault: false

offsetintegerOptionalDefault: 0

limitinteger · min: 1OptionalDefault: 20

Responses

200

Successful Response

application/json

Invitation read model.

idstring · uuidRequired

inviting_user_idstring · uuidRequired

emailstring · emailRequired

organization_idstring · uuidRequired

expiration_datestring · date-timeRequired

statestring · enumRequired

All invitation states.

Possible values:

auto_acceptbooleanOptional

Server-derived auto-accept intent.

Default: false

422

Validation Error

application/json

get/organizations/{organization_id}/invitations

HTTPcURLJavaScriptPython

GET /organizations/{organization_id}/invitations HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "inviting_user_id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[e-mail]",
    "organization_id": "123e4567-e89b-12d3-a456-426614174000",
    "expiration_date": "2026-07-10T16:57:27.282Z",
    "state": "pending",
    "auto_accept": false
  }
]

Create Organization Invitation Endpoint

post

Create an invitation for the organization.

Args: organization_id: ID of the organization. invitation: The invitation to create. user: The authenticated user. rbac: RBAC component. invitation_manager: Invitation manager.

Raises: RoleNotFound: If the role does not exist or does not belong to the organization. ValueError: If the invitation role is not an organization role.

Returns: The invitation, or None when the user was added directly without creating an invitation row.

Authorizations

OAuth2ComboScheme

OAuth2clientCredentialsRequired

Token URL:

---

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Path parameters

organization_idstring · uuidRequired

Body

application/json

Invitation create model.

emailstring · emailRequired

role_idstring · uuidRequired

suppress_emailbooleanOptional

Whether to suppress the invitation email for this create request. This only controls notification delivery.

Default: false

Responses

200

Successful Response

application/json

Invitation read model.

idstring · uuidRequired

inviting_user_idstring · uuidRequired

emailstring · emailRequired

organization_idstring · uuidRequired

expiration_datestring · date-timeRequired

statestring · enumRequired

All invitation states.

Possible values:

auto_acceptbooleanOptional

Server-derived auto-accept intent.

Default: false

422

Validation Error

application/json

post/organizations/{organization_id}/invitations

HTTPcURLJavaScriptPython

POST /organizations/{organization_id}/invitations HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "email": "[e-mail]",
  "role_id": "123e4567-e89b-12d3-a456-426614174000",
  "suppress_email": false
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "inviting_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[e-mail]",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "expiration_date": "2026-07-10T16:57:27.282Z",
  "state": "pending",
  "auto_accept": false
}

Delete Organization Invitation Endpoint

delete

Delete an invitation.

Args: organization_id: The ID of the organization, invitation_id: ID of the invitation to delete. user: The authenticated user. rbac: RBAC component. invitation_manager: Invitation manager.

Authorizations

OAuth2ComboScheme

OAuth2clientCredentialsRequired

Token URL:

---

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Path parameters

organization_idstring · uuidRequired

invitation_idstring · uuidRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

delete/organizations/{organization_id}/invitations/{invitation_id}

HTTPcURLJavaScriptPython

DELETE /organizations/{organization_id}/invitations/{invitation_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content