Organisation

Read the root organisation of your Exsited instance, with its name, type, contact and address fields.

The organisation endpoint reads the root organisation of your Exsited instance: its name, type, contact and address fields. The root organisation is read only. This area has 1 endpoint, and all seven SDKs call it.

At a glance

Endpoint	Method	Path	What it does
Retrieve the root organisation	GET	/settings/organisation	Returns the root organisation of your instance under organization.

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

• The response sits under organization, spelled with a z.
• The root organisation is read only. A PATCH to /settings/organisation returns 405.
• The root’s type is root, and it names itself as its parent_organization.
• Child organisations are a separate area. They are listed under /settings/organisations, and the root is never among them.