Saltar al contenido

Create an organization

Módulo Identity

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`.

  • Requiere la capacidad me.account.write.
  • Alcances de OAuth: me.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: CreateOrganizationRequest

organizations.create: CreateOrganizationRequest
CampoTipoObligatorioDescripción
namestringSíOrganization name.Restricciones: length 1 to 300
slugstringSíURL slug; reserved and taken slugs are refused.Restricciones: pattern ^[a-z0-9](?:[a-z0-9-]{1,61}[a-z0-9])?$
{
  "name": "Northwind Live",
  "slug": "northwind-live"
}

Respuesta 201: Organization

organizations.create: Organization
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the organization.
created_atstring (date-time)SíWhen the row was created.
updated_atstring (date-time)SíWhen the row was last updated.
namestringSíTrade name.Restricciones: length 1 to 300
slugstringSíURL slug.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
parent_org_idstring (uuid) | nullSíIdentifier of the partner organization.
organization_typestringSíLegal form from `xpms.organization_type` (decision D17): For-Profit, Nonprofit or Public Agency. It decides which worker classifications engagements may use.Restricciones: 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"
}

Ejemplos de código

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"}'