Organisation
The Organisation API covers configuration that lives at the tenant-organisation level: the general settings key/value map, the summary settings used to render the at-a-glance organisation profile, and a check that callers can use to determine whether an approval workflow has been configured.
Domain model
- Settings — a key/value map of organisation-level configuration. Individual values can be updated in place.
- Summary settings — the configuration backing the organisation summary card. Read or upsert in one call.
- Approval workflows — a lightweight existence check that lets the host application decide whether to surface workflow-driven UI.
Endpoints
Settings
List organisation settings
Read the tenant organisation's settings as a key/value map.
Update an organisation setting
Update a single organisation setting on the tenant.
Get summary settings
Read the tenant organisation's summary settings.
Upsert summary settings
Create or replace the tenant organisation's summary settings.