List Available Organisations

GET /tenants/{tenant}/clients/{clientCode}/books/available-organisations

Lists the organisations the practice's existing accounting connections can reach, asked of each platform live. The ones that cannot be chosen carry an unavailableReason: the organisation used as the practice's own books, or one already linked to another client. Usable ones come first. Only connections whose grant spans several organisations are consulted. On single-organisation platforms use the connect endpoint instead. Pass 'platform' to ask only that platform's connections.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

clientCode* path string
platform query string

Responses

200 OK
401 Unauthorized – Invalid or missing API key
404 Not Found

Try it