solarOS Organization API

Organization API

Versioning and Schema

The v1 API favors additive changes, explicit schema discovery, and stable error codes.

Version contract

The public path includes /v1 and response metadata includes version: v1. New optional fields may appear without a version change.

Schema expectations

Use /api/v1/schema to discover tenant-specific Field definitions before creating or updating resources with customFields.

Request objects are strict: unknown top-level fields return validation errors. PATCH is a typed partial update: omitted fields remain unchanged, null clears only nullable fields, and supplied arrays replace the entire array unless an operation explicitly says otherwise.

Ownership fields are generally accepted only at creation. Generic PATCH endpoints reject owner reassignment unless an operation explicitly documents that capability.