Organizations

List Organizations Endpoint

get

Endpoint to list organizations.

Args: name: Filter by organization name. offset: Query offset. limit: Query limit. auth_context: The authentication context. rbac: RBAC component. organization_manager: Organization manager owner_id: Id of the Organization owner

Returns: List of organization models.

Authorizations

Query parameters

namestringOptional

offsetintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

owner_idstring · uuidOptional

Responses

application/json

object[]Optional

Model for viewing organizations.

application/json

get

HTTPcURLJavaScriptPython

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

[
  {
    "name": "text",
    "description": "text",
    "logo_url": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created": "2025-04-21T16:49:05.607Z",
    "updated": "2025-04-21T16:49:05.607Z",
    "owner": {
      "name": "text",
      "avatar_url": "text",
      "company": "text",
      "job_title": "text",
      "metadata": {},
      "password": "text",
      "password_expired": true,
      "email": "[e-mail]",
      "oauth_provider": "text",
      "oauth_id": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "is_active": true,
      "is_superuser": true
    },
    "has_active_subscription": true,
    "trial_expiry": 1
  }
]

Create Organization Endpoint

post

Endpoint to create an organization.

Args: organization: The organization to create. user: The authenticated user. rbac: RBAC component. organization_manager: Organization manager

Raises: IllegalOperationError: If the user is not allowed to create an organization for another user or to set sensitive user fields. OrganizationLimitExceeded: If the user already has an organization.

Returns: Model of the created organization.

Authorizations

Body

Model for creating organizations.

idstring · uuidOptional

namestring · min: 1 · max: 50Required

descriptionstring · min: 1 · max: 256Optional

logo_urlstringOptional

owner_idstring · uuidOptional

The UUID of the organization owner. If not set, the current user is set as the owner.

Responses

application/json

objectOptional

Model for viewing organizations.

application/json

post

HTTPcURLJavaScriptPython

POST /organizations HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "logo_url": "text",
  "owner_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "name": "text",
  "description": "text",
  "logo_url": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created": "2025-04-21T16:49:05.607Z",
  "updated": "2025-04-21T16:49:05.607Z",
  "owner": {
    "name": "text",
    "avatar_url": "text",
    "company": "text",
    "job_title": "text",
    "metadata": {},
    "password": "text",
    "password_expired": true,
    "email": "[e-mail]",
    "oauth_provider": "text",
    "oauth_id": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "is_active": true,
    "is_superuser": true
  },
  "has_active_subscription": true,
  "trial_expiry": 1
}

Get Organization Endpoint

get

Endpoint to get an organization.

Args: organization_id_or_name: ID or name of the organization to get. include_subscription_status: Whether to include the subscription status of the org auth_context: The authentication context. rbac: RBAC component. organization_manager: Organization manager

Returns: Model of the organization.

Authorizations

Path parameters

organization_id_or_nameany ofRequired

Query parameters

include_subscription_statusbooleanOptionalDefault: false

Responses

application/json

objectOptional

Model for viewing organizations.

application/json

get

HTTPcURLJavaScriptPython

GET /organizations/{organization_id_or_name} HTTP/1.1
Host: 
Accept: */*

{
  "name": "text",
  "description": "text",
  "logo_url": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created": "2025-04-21T16:49:05.607Z",
  "updated": "2025-04-21T16:49:05.607Z",
  "owner": {
    "name": "text",
    "avatar_url": "text",
    "company": "text",
    "job_title": "text",
    "metadata": {},
    "password": "text",
    "password_expired": true,
    "email": "[e-mail]",
    "oauth_provider": "text",
    "oauth_id": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "is_active": true,
    "is_superuser": true
  },
  "has_active_subscription": true,
  "trial_expiry": 1
}

Delete Organization Endpoint

delete

Endpoint to delete an organization.

Args: organization_id: ID of the organization to delete. user: The authenticated user. organization_manager: Organization manager

Raises: IllegalOperationError: If the user does not have permissions to delete the organization.

Authorizations

Path parameters

organization_idstring · uuidRequired

Responses

application/json

anyOptional

application/json

delete

HTTPcURLJavaScriptPython

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

No content

Update Organization Endpoint

patch

Endpoint to update an organization.

Args: organization_id: ID of the organization to update. update: The organization update. user: The authenticated user. rbac: RBAC component. organization_manager: Organization manager

Returns: Model of the updated organization.

Raises: IllegalOperationError: If the user does not have permissions to update the organization.

Authorizations

Path parameters

organization_idstring · uuidRequired

Body

Model for updating organizations.

namestring · min: 1 · max: 50Optional

descriptionstring · min: 1 · max: 256Optional

logo_urlstringOptional

owner_idstring · uuidOptional

Responses

application/json

objectOptional

Model for viewing organizations.

application/json

patch

HTTPcURLJavaScriptPython

PATCH /organizations/{organization_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "name": "text",
  "description": "text",
  "logo_url": "text",
  "owner_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "name": "text",
  "description": "text",
  "logo_url": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created": "2025-04-21T16:49:05.607Z",
  "updated": "2025-04-21T16:49:05.607Z",
  "owner": {
    "name": "text",
    "avatar_url": "text",
    "company": "text",
    "job_title": "text",
    "metadata": {},
    "password": "text",
    "password_expired": true,
    "email": "[e-mail]",
    "oauth_provider": "text",
    "oauth_id": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "is_active": true,
    "is_superuser": true
  },
  "has_active_subscription": true,
  "trial_expiry": 1
}