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 owner_username: Username of the Organization owner

Returns: List of organization models.

Authorizations

OAuth2ComboScheme

OAuth2clientCredentialsRequired

Token URL:

---

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Query parameters

nameany ofOptional

stringOptional

or

nullOptional

offsetintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

owner_idany ofOptional

string · uuidOptional

or

nullOptional

owner_usernameany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Model for viewing organizations.

namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

logo_urlany ofOptional

stringOptional

or

nullOptional

idstring · uuidRequired

createdstring · date-timeRequired

updatedstring · date-timeRequired

has_active_subscriptionany ofOptional

If the organization has an active subscription. This means the subscription is either in the trial period or the organization is billed for it.

booleanOptional

or

nullOptional

trial_expiryany ofOptional

Time in seconds until the trial expires. If the organization is not in trial, this will be None.

integerOptional

or

nullOptional

422

Validation Error

application/json

get

/organizations

HTTPcURLJavaScriptPython

GET /organizations HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "name": "text",
    "description": "text",
    "logo_url": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created": "2026-04-02T13:57:44.124Z",
    "updated": "2026-04-02T13:57:44.124Z",
    "owner": {
      "password": "text",
      "password_expired": true,
      "name": "text",
      "avatar_url": "text",
      "company": "text",
      "job_title": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text",
      "email": "text",
      "oauth_provider": "text",
      "oauth_id": "text",
      "is_active": true,
      "is_superuser": false,
      "is_service_account": false,
      "organization_id": "123e4567-e89b-12d3-a456-426614174000",
      "is_onboarded": false
    },
    "links": [
      {
        "label": "text",
        "url": "text"
      }
    ],
    "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. Also raised if the user is a service account. OrganizationLimitExceeded: If the user already has an organization.

Returns: Model of the created organization.

Authorizations

OAuth2ComboScheme

OAuth2clientCredentialsRequired

Token URL:

---

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Body

application/json

Model for creating organizations.

idany ofOptional

string · uuidOptional

or

nullOptional

namestring · min: 1 · max: 50Required

descriptionany ofOptional

string · min: 1 · max: 256Optional

or

nullOptional

logo_urlany ofOptional

stringOptional

or

nullOptional

linksany ofOptional

Optional list of organization links to show in the dashboard.

or

nullOptional

owner_idany ofOptional

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

string · uuidOptional

or

nullOptional

Responses

200

Successful Response

application/json

Model for viewing organizations.

namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

logo_urlany ofOptional

stringOptional

or

nullOptional

idstring · uuidRequired

createdstring · date-timeRequired

updatedstring · date-timeRequired

has_active_subscriptionany ofOptional

If the organization has an active subscription. This means the subscription is either in the trial period or the organization is billed for it.

booleanOptional

or

nullOptional

trial_expiryany ofOptional

Time in seconds until the trial expires. If the organization is not in trial, this will be None.

integerOptional

or

nullOptional

422

Validation Error

application/json

post

/organizations

HTTPcURLJavaScriptPython

POST /organizations HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "logo_url": "text",
  "links": [
    {
      "label": "text",
      "url": "text"
    }
  ],
  "owner_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "name": "text",
  "description": "text",
  "logo_url": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created": "2026-04-02T13:57:44.124Z",
  "updated": "2026-04-02T13:57:44.124Z",
  "owner": {
    "password": "text",
    "password_expired": true,
    "name": "text",
    "avatar_url": "text",
    "company": "text",
    "job_title": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "email": "text",
    "oauth_provider": "text",
    "oauth_id": "text",
    "is_active": true,
    "is_superuser": false,
    "is_service_account": false,
    "organization_id": "123e4567-e89b-12d3-a456-426614174000",
    "is_onboarded": false
  },
  "links": [
    {
      "label": "text",
      "url": "text"
    }
  ],
  "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

OAuth2ComboScheme

OAuth2clientCredentialsRequired

Token URL:

---

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Path parameters

organization_id_or_nameany ofRequired

string · uuidOptional

or

stringOptional

Query parameters

include_subscription_statusbooleanOptionalDefault: false

Responses

200

Successful Response

application/json

Model for viewing organizations.

namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

logo_urlany ofOptional

stringOptional

or

nullOptional

idstring · uuidRequired

createdstring · date-timeRequired

updatedstring · date-timeRequired

has_active_subscriptionany ofOptional

If the organization has an active subscription. This means the subscription is either in the trial period or the organization is billed for it.

booleanOptional

or

nullOptional

trial_expiryany ofOptional

Time in seconds until the trial expires. If the organization is not in trial, this will be None.

integerOptional

or

nullOptional

422

Validation Error

application/json

get

/organizations/{organization_id_or_name}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "text",
  "logo_url": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created": "2026-04-02T13:57:44.124Z",
  "updated": "2026-04-02T13:57:44.124Z",
  "owner": {
    "password": "text",
    "password_expired": true,
    "name": "text",
    "avatar_url": "text",
    "company": "text",
    "job_title": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "email": "text",
    "oauth_provider": "text",
    "oauth_id": "text",
    "is_active": true,
    "is_superuser": false,
    "is_service_account": false,
    "organization_id": "123e4567-e89b-12d3-a456-426614174000",
    "is_onboarded": false
  },
  "links": [
    {
      "label": "text",
      "url": "text"
    }
  ],
  "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

OAuth2ComboScheme

OAuth2clientCredentialsRequired

Token URL:

---

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Path parameters

organization_idstring · uuidRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

delete

/organizations/{organization_id}

HTTPcURLJavaScriptPython

DELETE /organizations/{organization_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
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 user_manager: User manager

Returns: Model of the updated organization.

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

Authorizations

OAuth2ComboScheme

OAuth2clientCredentialsRequired

Token URL:

---

OAuth2authorizationCodeRequired

Authorization URL: Token URL: Refresh URL:

Path parameters

organization_idstring · uuidRequired

Body

application/json

Model for updating organizations.

nameany ofOptional

string · min: 1 · max: 50Optional

or

nullOptional

descriptionany ofOptional

string · min: 1 · max: 256Optional

or

nullOptional

logo_urlany ofOptional

stringOptional

or

nullOptional

linksany ofOptional

List of organization links to show in the dashboard. If set, replaces the entire list.

or

nullOptional

owner_idany ofOptional

string · uuidOptional

or

nullOptional

Responses

200

Successful Response

application/json

Model for viewing organizations.

namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

logo_urlany ofOptional

stringOptional

or

nullOptional

idstring · uuidRequired

createdstring · date-timeRequired

updatedstring · date-timeRequired

has_active_subscriptionany ofOptional

If the organization has an active subscription. This means the subscription is either in the trial period or the organization is billed for it.

booleanOptional

or

nullOptional

trial_expiryany ofOptional

Time in seconds until the trial expires. If the organization is not in trial, this will be None.

integerOptional

or

nullOptional

422

Validation Error

application/json

patch

/organizations/{organization_id}

HTTPcURLJavaScriptPython

PATCH /organizations/{organization_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "name": "text",
  "description": "text",
  "logo_url": "text",
  "links": [
    {
      "label": "text",
      "url": "text"
    }
  ],
  "owner_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "name": "text",
  "description": "text",
  "logo_url": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created": "2026-04-02T13:57:44.124Z",
  "updated": "2026-04-02T13:57:44.124Z",
  "owner": {
    "password": "text",
    "password_expired": true,
    "name": "text",
    "avatar_url": "text",
    "company": "text",
    "job_title": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "email": "text",
    "oauth_provider": "text",
    "oauth_id": "text",
    "is_active": true,
    "is_superuser": false,
    "is_service_account": false,
    "organization_id": "123e4567-e89b-12d3-a456-426614174000",
    "is_onboarded": false
  },
  "links": [
    {
      "label": "text",
      "url": "text"
    }
  ],
  "has_active_subscription": true,
  "trial_expiry": 1
}