Child organisations

List, create, read, update and delete the child organisations below the root organisation of your Exsited instance.

Child organisations are the organisations below the root organisation of your Exsited instance. You can list, create, read, update and delete them. This area has 5 endpoints, and all seven SDKs call every one.

Creating a child organisation changes your organisation hierarchy and assigns an existing user to it. The create also depends on your licence.

At a glance

Endpoint	Method	Path	What it does
List child organisations	GET	/settings/organisations	Returns one page of the child organisations on your instance; the root is never included.
Create a child organisation	POST	/settings/organisations	Creates a child organisation and returns it under organization.
Retrieve a child organisation	GET	/settings/organisations/{organisation_id}	Returns one child organisation by its id.
Delete a child organisation	DELETE	/settings/organisations/{organisation_id}	Deletes a child organisation and returns no body.
Update a child organisation	PATCH	/settings/organisations/{organisation_id}	Changes a child organisation’s fields and returns it.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Bodies and records sit under organization, spelled with a z.
• The root organisation is never in the listing. Read it with GET /settings/organisation instead.
• Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.
• Delete returns 204.