Organisations
Read and update the organisation your API key belongs to
Each API key is bound to a single organisation. The endpoints below let you read and update that organisation's profile — name, contact details, address, tax information, and the default messages used on quotes and invoices.
You cannot list organisations through the API. Your key is scoped to one organisation and that scope is set when the key is created in the developer portal.
Endpoints
- GET
/organisations/{orgId}— Get organisation details - PUT
/organisations/{orgId}— Update organisation
Required scopes: organisation:read / organisation:write.
Writable extras include timezone (IANA), reply-to defaults, latitude /
longitude, formUnitSystem (metric|imperial), formGateStatuses, and
recurring defaults. Sending null for a recurring default deletes the field
(FieldValue.delete()). stripeChargesEnabled is read-only. members and
subscription fields are never returned.
On PUT, send only the fields you want to change — everything is optional and
unspecified fields are left untouched. The members map and teamAccessCode
are persisted in Firestore but never returned by the API.
Machine-readable version: OpenAPI spec.