Professional API: Organisation Keys

A normal professional API key reads only your own practice. An organisation key adds the pro:org:read scope, which widens every read on the Orchard72 Professional API to the rows of every seat in your organisation: appointments, clients, matters, invoices, time entries, documents and the rest.

• It works alongside pro:read and does not grant anything on its own, so give an organisation key both scopes.
• It is read only. An organisation key cannot carry any write scope, so it cannot create wills or change data.

Only an active owner or admin of the organisation can create an organisation key. Admins who are suspended or on leave cannot.

1. Sign in and open your developer hub from your account menu.
2. Create a new key and tick Organisation-wide (all seats).
3. If you administer more than one organisation, choose which one the key belongs to.
4. Copy the key straight away. It is shown only once.

The key belongs to the organisation, not to the person who created it. It keeps working if its creator leaves the firm or stops being an admin, so an integration does not break because of a staff change.

It stops working if the organisation is dissolved, suspended or merged, or loses API access on its plan.

An organisation key can read client data across the whole firm, so treat it like a master password.

• Any active owner or admin of the organisation can see and revoke its keys.
• Revoke a key at once if you think it has been exposed, then create a new one.
• Keep it on a server, never in a browser, a mobile app or a shared document.

• Syncing your practice data: cursor pagination, changes-only syncs and bulk export.
• Getting started: authentication and your first request.