Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Creating Organizations

:::info Coming Soon This feature is under active development. The design below reflects our planned implementation. :::

Organizations allow you to group users within your application. This page describes how organizations will be created and managed.

How Organizations Are Created

Users will create organizations through the API or through your application's UI. The user who creates an organization automatically becomes its first admin.

Organization Properties

PropertyDescription
nameDisplay name of the organization
slugURL-friendly identifier (unique within the application)
logoURL to the organization's logo
metadataArbitrary key-value data for application-specific use

Planned API Endpoints

Create an organization

POST /api/organizations
{
  "name": "Acme Corp",
  "slug": "acme-corp"
}

List organizations

GET /api/organizations

Returns all organizations the current user belongs to.

Get an organization

GET /api/organizations/:id

Update an organization

PUT /api/organizations/:id
{
  "name": "Acme Corporation",
  "logo": "https://example.com/logo.png"
}

Delete an organization

DELETE /api/organizations/:id

Only organization admins can delete an organization. Deleting an organization removes all memberships but does not delete the user accounts.