Skip to main content

Create Organization

Register a new organization in the Minimal system:

Request Body

FieldTypeRequiredDescription
org_idstring✅ YesUnique identifier for the org — generate a ULID
namestring✅ YesDisplay name of the organization
abbreviationstring✅ YesShort slug — lowercase, no spaces (e.g. acme)
admin_emailstring✅ YesPrimary admin email address
admin_namestring✅ YesPrimary admin full name
addressstring✅ YesStreet address
statestring✅ YesState or province
countrystring✅ YesCountry
pin_codestring✅ YesPostal / ZIP code

Required Headers

All requests to Minimal must include these headers.

They are mandatory — missing any header results in a 400 Bad Request.

HeaderFormatDescription
X-User-IdStringAuthenticated user's identifier
X-Server-KeyStringServer-level auth key — contact your admin
Content-TypeStringMust be application/json

Response

201 Created — organization registered successfully:

{
"code": 201,
"status": "Created",
"message": "organisation created successfully"
}

208 Already Reported — an org with this org_id already exists — safe to proceed to Create Project:

{
"code": 208,
"status": "Already Reported",
"message": "organisation already exists"
}

Common Errors

CodeReason
400Malformed JSON body or missing required field
401Missing X-User-Id or X-Server-Key header
403X-Server-Key is invalid
422Field value violates a constraint — e.g. abbreviation contains spaces or uppercase