Create an organization

Identity module

POST/organizationsorganizations.create

Creates an organization with the caller as its Owner, in one transaction, through `app.create_organization`. It starts a 14-day Pro trial with no card and moves to the Access plan when the trial ends unless a card is added (Section 14.7). A reserved or taken slug is refused with 422. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability me.account.write.
OAuth scopes: me.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: CreateOrganizationRequest

organizations.create: CreateOrganizationRequest
Field	Type	Required	Description
name	string	Yes	Organization name.Constraints: length 1 to 300
slug	string	Yes	URL slug; reserved and taken slugs are refused.Constraints: pattern ^[a-z0-9](?:[a-z0-9-]{1,61}[a-z0-9])?$

{
  "name": "Northwind Live",
  "slug": "northwind-live"
}

Response 201: Organization

organizations.create: Organization
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the organization.
created_at	string (date-time)	Yes	When the row was created.
updated_at	string (date-time)	Yes	When the row was last updated.
name	string	Yes	Trade name.Constraints: length 1 to 300
slug	string	Yes	URL slug.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
parent_org_id	string (uuid) \| null	Yes	Identifier of the partner organization.
organization_type	string	Yes	Legal form from `xpms.organization_type` (decision D17): For-Profit, Nonprofit or Public Agency. It decides which worker classifications engagements may use.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "name": "Northwind Live",
  "slug": "northwind-live",
  "parent_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "organization_type": "For-Profit"
}

Code samples

curl -X POST "$XOS_BASE_URL/organizations" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Northwind Live","slug":"northwind-live"}'

const { data } = await xos.organizations.create({
    "name": "Northwind Live",
    "slug": "northwind-live"
  });

response = xos.organizations.create({"name": "Northwind Live", "slug": "northwind-live"})

xos organizations create --data '{"name":"Northwind Live","slug":"northwind-live"}'