Skip to content

Organizations

List Orgs

List all organizations the authenticated user belongs to.

Responses

StatusDescriptionBody
200Successful ResponseOrgResponse[]
422Validation ErrorHTTPValidationError

Create Org

Create a new organization.

The authenticated user becomes the OWNER of the new organization. With no slug the service derives and uniquifies one from the name; an explicit slug is validated (shape, length, reserved words) and must be free.

Request body (required)

FieldTypeRequiredDescription
descriptionstringno
namestringyes
slugstringno

Responses

StatusDescriptionBody
201Successful ResponseOrgResponse
422Validation ErrorHTTPValidationError

Get Org

Get organization details.

Requires membership in the organization (user) or belonging to it (agent).

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful ResponseOrgResponse
422Validation ErrorHTTPValidationError

Update Org

Update organization details.

Requires ADMIN or OWNER role.

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes

Request body (required)

FieldTypeRequiredDescription
descriptionstringno
namestringno
slugstringno

Responses

StatusDescriptionBody
200Successful ResponseOrgResponse
422Validation ErrorHTTPValidationError

Delete Org

Delete an organization.

Requires OWNER role.

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes

Responses

StatusDescriptionBody
204Successful Response
422Validation ErrorHTTPValidationError

Get Slug Rules

The rules an organization address must satisfy.

Served so the create-organization wizard can flag a reserved or malformed address as the user types, without a hand-copied duplicate of the reserved list rotting in the frontend. The server-side check in create_org is still the authority.

Responses

StatusDescriptionBody
200Successful ResponseSlugRulesResponse
422Validation ErrorHTTPValidationError