OrganizationResource

Create an organization

Creates a new organization.

Authorization:

  • Organization API key: creates a sub-organization under the key's root organization only. The key must be bound to a root organization (IsRootOrganization). rootOrganizationId in the body must not be set; the child inherits the root org billable user. Keys bound to a sub-organization cannot create further sub-organizations.
  • Personal access token (PAT): delegates to the token user's permissions. Top-level org creation omits rootOrganizationId and is allowed for any user with organizations:create scope. Child org creation requires organizations:create scope plus Owner role on the root org, matching billable user, and the root org must be IsRootOrganization. Sub-organizations cannot be used as rootOrganizationId.

Required API key permissions

  • Scope: organizations:create
  • Accepted key types: organization API key (org-wide), organization API key (team-scoped), personal access token (org-wide), personal access token (team-scoped)
  • Access: Access is checked against the specific resource (team or organization reachability).
  • Notes: Organization API keys can create sub-organizations under the key's root organization only. Personal access tokens creating a child organization require the Owner role on the root organization.
post/api/public/v1/organizations

Request

Request body

displayNamestring required
rootOrganizationIdstring uuid nullable

Response

Created

idstring uuid
displayNamestring nullable
rootOrganizationIdstring uuid nullable

Changes

No recorded changes to this operation across all 1 revision of this API.