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

Organizations group users within an application. The user who creates an organization automatically becomes its first admin.

From the Dashboard

  1. Open an application in the dashboard.
  2. Go to User Management → Organizations.
  3. Click Create organization and fill in the name, slug, and optional logo/metadata.
  4. You'll be taken to the new organization's detail page, where you can invite members.

Organization Properties

PropertyDescription
nameDisplay name. 1–255 characters.
slugURL-friendly identifier, unique within the application. 3–63 characters, lowercase letters, numbers, and hyphens. Must start with a letter and contain no consecutive hyphens.
logo_urlOptional HTTPS URL to the organization's logo.
metadataOptional free-form JSON object for application-specific data.

API

Create an organization

POST /api/organizations
{
  "name": "Acme Corp",
  "slug": "acme-corp",
  "logo_url": "https://example.com/logo.png",
  "metadata": { "plan": "pro" }
}

Returns 201 with the created organization. The caller becomes its first admin in a single transactional batch.

List organizations

GET /api/organizations?page=1&limit=20

Returns only the organizations the current user is a member of, paginated.

Get an organization

GET /api/organizations/:id

Returns 404 if the caller is not a member.

Update an organization

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

Admin-only. At least one field must be provided.

Delete an organization

DELETE /api/organizations/:id

Admin-only. Deletes the organization, all memberships, and all invitations via cascading deletes. User accounts are not deleted.