Organizations

Create an organization.

Creates a new organization with the authenticated user as its first owner, provisioning the root team alongside it. The chosen slug must be available across all organizations.

post/api/v1/orgs

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

displayNamestring required

Human-readable organization name.

slugstring nullable required

Optional caller-provided slug.

iconUrlstring nullable required

Optional organization icon data URL.

Response

Created

idstring required

Stable organization identifier.

slugstring nullable required

Organization slug.

displayNamestring required

Human-readable organization name.

iconUrlstring nullable required

Optional organization icon data URL.

rolestring nullable required

Current user's role in the organization, when available.

createdAtUtcstring date-time required

UTC timestamp when the organization was created.

activatedAtUtcstring date-time nullable required

UTC timestamp when the organization became active.

autoInviteSameDomainEnabledboolean required

Whether same-domain onboarding is enabled.

autoInviteSameDomainstring nullable required

Normalized domain currently claimed for auto-invites.

autoInviteDefaultRolestring required

Role assigned to auto-created same-domain invitations.

autoInviteSameDomainCanEnableboolean required

Whether the organization can enable same-domain onboarding.

autoInviteSameDomainBlockReasonstring nullable required

Reason enabling is blocked, when any.

Changes