Skip to content
Hayonix

API reference · Organizations

Create an organization (you become its owner; a default project is created)

POST/v1/orgs
Console sessionIdempotency-Key

Creates the organization with you as its owner, its credit balance and a first project, all at once. The response includes that default project. Organizations cannot be deleted.

Console session only. The console calls this with a signed-in session; API keys are refused.

Request

Headers
HeaderRequiredDescription
Idempotency-KeynoMakes a retry safe: the same key and request within 24 hours return the original response (see Idempotency). The SDKs send one for you.

Body

JSON (application/json): CreateOrganizationRequest.

  • namestringrequired

    Its name

    1–100 characters

  • slugstring

    Globally unique; derived from the name when omitted

    pattern ^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$

Response

201 CreatedOrganization — The new organization and its default project

  • objectstringrequired

    Always `organization`: the type of this object

    One oforganization

  • idstringrequired

    Unique ID (`org_…`)

    ID with prefix org_

  • namestringrequired

    Its name

  • slugstringrequired

    Short URL-safe name, unique across the platform

  • rolestring | nullrequired

    Your role in this organization; null when the caller is an API key

    One ofowneradmindeveloperbillingviewer

  • created_atstring (date-time)required

    When it was created (ISO 8601, UTC)

  • default_projectProjectrequired
    Show 9 fields of default_project
    • objectstringrequired

      Always `project`: the type of this object

      One ofproject

    • idstringrequired

      Unique ID (`prj_…`)

      ID with prefix prj_

    • org_idstringrequired

      Organization it belongs to

      ID with prefix org_

    • namestringrequired

      Its name

    • slugstringrequired

      Short URL-safe name, unique within the organization

    • descriptionstring | nullrequired

      Free-text description

    • archived_atstring (date-time) | nullrequired

      When it was archived (null while it is active) (ISO 8601, UTC)

    • created_atstring (date-time)required

      When it was created (ISO 8601, UTC)

    • updated_atstring (date-time)required

      When it last changed (ISO 8601, UTC)

Example response
Example response
{
  "object": "organization",
  "id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "name": "string",
  "slug": "string",
  "role": "owner",
  "created_at": "2026-01-01T00:00:00.000Z",
  "default_project": {
    "object": "project",
    "id": "prj_01jc5zq4m8k3v6x9t2w7r0b1e4",
    "org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
    "name": "string",
    "slug": "string",
    "description": "string",
    "archived_at": "2026-01-01T00:00:00.000Z",
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
402insufficient_credit_errorThe organization is out of credit or over a spend limit.
409conflict_error idempotency_in_progressA request with the same Idempotency-Key is still running.
422idempotency_error idempotency_key_reusedThe Idempotency-Key was used with a different request.
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.