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

MethodPathDescription
GET/organizations/childrenList all child organisations
POST/organizations/childrenCreate a new child organisation
GET/organizations/children/:idGet a child organisation by ID
PATCH/organizations/children/:idUpdate a child organisation's name + operator defaults
DELETE/organizations/children/:idDelete a child organisation (requires confirmation)
GET/organizations/children/:id/keysList API keys for a child organisation
POST/organizations/children/:id/keysCreate an API key for a child organisation
DELETE/organizations/children/:id/keys/:keyIdDelete 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-as header). To set operator defaults on the organisation you are currently acting as, use PATCH /organizations/me instead.
  • Permanent deletion requires the x-confirm-delete: true header.
  • API key management enforces a limit of 20 manually-created keys per child organisation.

Required scope: organizations:read for listing and getting, organizations:write for create, update, remove, and delete