Child organisations
Manage parent-child organisation relationships. A parent organisation can create, list, update, remove, and delete child organisations, and manage their API keys. Only single-level hierarchy is supported โ a child organisation cannot itself have children.
โถEndpoints
| Method | Path | Description |
|---|---|---|
| GET | /organizations/children | List all child organisations |
| POST | /organizations/children | Create a new child organisation |
| GET | /organizations/children/:id | Get a child organisation by ID |
| PATCH | /organizations/children/:id | Update a child organisation's name + operator defaults |
| DELETE | /organizations/children/:id | Delete a child organisation (requires confirmation) |
| GET | /organizations/children/:id/keys | List API keys for a child organisation |
| POST | /organizations/children/:id/keys | Create an API key for a child organisation |
| DELETE | /organizations/children/:id/keys/:keyId | Delete an API key for a child organisation |
โถAccess control
- All endpoints require the caller to be a top-level organisation (not a child).
- All endpoints are blocked when acting-as (
x-acting-asheader). To set operator defaults on the organisation you are currently acting as, usePATCH /organizations/meinstead. - Permanent deletion requires the
x-confirm-delete: trueheader. - API key management enforces a limit of 20 manually-created keys per child organisation.
Required scope:
organizations:readfor listing and getting,organizations:writefor create, update, remove, and delete