v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB
Organizations

Create an organization

Creates a new organization with the given name for an instance. You can specify an optional slug for the new organization. If provided, the organization slug can contain only lowercase alphanumeric characters (letters and digits) and the dash "-". Organization slugs must be unique for the instance. You can provide additional metadata for the organization and set any custom attribute you want. Organizations support private and public metadata. Private metadata can only be accessed from the Backend API. Public metadata can be accessed from the Backend API, and are read-only from the Frontend API. The created_by user will see this as their active organization the next time they create a session, presuming they don't explicitly set a different organization as active before then.

post/organizations

Request body

namestring required

The name of the new organization. May not contain URLs or HTML. Max length: 256

created_bystring nullable

The ID of the User who will become the administrator for the new organization

private_metadataobject nullable

Metadata saved on the organization, accessible only from the Backend API

public_metadataobject nullable

Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API

slugstring nullable

A slug for the new organization. Can contain only lowercase alphanumeric characters and the dash "-". Must be unique for the instance. This field should only be included when slugs are enabled in the organization settings, refer to our documentation.

max_allowed_membershipsinteger nullable

The maximum number of memberships allowed for this organization

created_atstring nullable

A custom date/time denoting when the organization was created, specified in RFC3339 format (e.g. 2012-10-20T07:15:20.902Z).

role_set_keystring nullable

The key of the role set to assign to this organization.

Response

An organization

object'organization' required
idstring required
namestring required
slugstring required
image_urlstring
has_imageboolean required
members_countinteger
missing_member_with_elevated_permissionsboolean
pending_invitations_countinteger
max_allowed_membershipsinteger required
admin_delete_enabledboolean required
public_metadataobject required
private_metadataobject
created_bystring
created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

last_active_atinteger

Unix timestamp of last activity.

role_set_keystring nullable

The key of the role set assigned to this organization.