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. user: The authenticated user. rbac: RBAC component. invitation_manager: Invitation manager.

Returns: List of invitations.

Authorizations

Path parameters

organization_idstring · uuidRequired

Query parameters

inviting_user_idstring · uuidOptional

emailstring · emailOptional

only_pendingbooleanOptionalDefault: false

Responses

application/json

object[]Optional

Invitation read model.

application/json

get

HTTPcURLJavaScriptPython

GET /organizations/{organization_id}/invitations HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "inviting_user_id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "text",
    "organization_id": "123e4567-e89b-12d3-a456-426614174000",
    "role_id": "123e4567-e89b-12d3-a456-426614174000",
    "role_name": "text",
    "expiration_date": "2025-04-21T16:49:05.607Z",
    "state": "pending"
  }
]

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.

Authorizations

Path parameters

organization_idstring · uuidRequired

Body

Invitation create model.

emailstring · emailRequired

role_idstring · uuidRequired

Responses

application/json

objectOptional

Invitation read model.

application/json

post

HTTPcURLJavaScriptPython

POST /organizations/{organization_id}/invitations HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 75

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "inviting_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "role_id": "123e4567-e89b-12d3-a456-426614174000",
  "role_name": "text",
  "expiration_date": "2025-04-21T16:49:05.607Z",
  "state": "pending"
}

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

Path parameters

organization_idstring · uuidRequired

invitation_idstring · uuidRequired

Responses

application/json

anyOptional

application/json

delete

HTTPcURLJavaScriptPython

DELETE /organizations/{organization_id}/invitations/{invitation_id} HTTP/1.1
Host: 
Accept: */*

No content