Organizations / Tenants API Reference
PlatformEndpoint reference for organizations, tenants, context, hierarchy, locations and configuration.
Isolation
Tenant-scoped by design
Hierarchy
Organizations + sub-organizations
Access
Membership + role context
Configuration
Policies, modules & branding
Organizations
| Method | Endpoint | Purpose |
|---|---|---|
| GET | /v1/organizations | List accessible organizations |
| POST | /v1/organizations | Create organization |
| GET | /v1/organizations/{id} | Get organization |
| PATCH | /v1/organizations/{id} | Update organization |
Tenants
| Method | Endpoint | Purpose |
|---|---|---|
| GET | /v1/tenants | List accessible tenants |
| POST | /v1/tenants | Provision tenant |
| GET | /v1/tenants/{id} | Get tenant |
| PATCH | /v1/tenants/{id} | Update tenant |
Context
Active contextCopy
X-Tenant-Id: tnt_01
X-Membership-Id: mbr_01Hierarchy
| Endpoint | Purpose |
|---|---|
| GET /v1/organizations/{id}/children | List child organizations |
| GET /v1/organizations/{id}/tenants | List organization tenants |
Locations
| Method | Endpoint |
|---|---|
| GET | /v1/locations |
| POST | /v1/locations |
| GET | /v1/locations/{id} |
| PATCH | /v1/locations/{id} |
Configuration
| Endpoint | Purpose |
|---|---|
| GET /v1/tenants/{id}/configuration | Read public tenant configuration |
| PATCH /v1/tenants/{id}/configuration | Update supported settings |
| GET /v1/tenants/{id}/entitlements | Read feature entitlements and quotas |
Response codes
| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Validation error |
| 403 | Insufficient tenant/organization access |
| 404 | Resource not found in accessible context |
| 409 | Conflict or invalid lifecycle state |