Practice Manager API
Firm, Clients & Members
Read the authorized firm’s profile, the client workspaces it manages, and its team, and create new client workspaces. Client workspace ids from this group are what every client workspace route takes.
Last updated 2026-10-30
Overview
These routes describe the practice your API key belongs to and add clients to it. Start with List client workspaces: the `id` of each row is the value to send as the `count-workspace-id` header on client workspace routes, and as `clientWorkspaceUuid` on firm tasks.
The read routes need the `firm:read` scope and work with any key, including one limited to selected client workspaces. None of them is paginated.
Create a client workspace sets up a new client with its own books, with no consent screen and no COUNT login for the client. The same key can work in it straight away. Use it when your platform signs up a business and needs a COUNT workspace for it.
Key concepts
The firm’s own workspace is a client too
The firm’s practice workspace is listed last, with `isOwnedByFirm: true`, and is reachable through client workspace routes like any client.
Creating clients safely
Send `externalReference` with your own id for the client. A retry with the same reference returns the client already created instead of a second one, so a create whose response you lost is safe to repeat.
Membership id vs user id
Each member row has two UUIDs: `id` identifies the membership and `user.id` identifies the person. Task assignee fields take `user.id`.
The client workspace object
One row of List client workspaces.
Attributes
iduuidClient workspace UUID. Send it as `count-workspace-id` on client workspace routes.
namestringWorkspace (business) name.
currencystringWorkspace currency (ISO 4217). Defaults to USD.
isPracticeManagerOnlybooleanTrue for a portal-only client: the firm manages it in Practice Manager but it has no books, so ledger routes return 403 for it.
isOwnedByFirmbooleanTrue when the firm owns the workspace (including the firm’s own practice workspace) rather than only servicing it. Many client workspaces can be firm-owned; the firm’s own workspace is the last row.
ownsItbooleanLegacy ownership flag on the firm–client link. Prefer `isOwnedByFirm`. May be null.
dateJoineddatetimeWhen the client was linked to the firm. For the firm’s own workspace, when it was created.
externalReferencestringYour own id for the client, as sent to Create a client workspace. Null when none was given, and for the firm’s own workspace.
{
"id": "5e4d3c2b-1a09-4f8e-8d7c-6b5a49382716",
"name": "Harbor Coffee Co.",
"currency": "USD",
"isPracticeManagerOnly": false,
"ownsIt": false,
"isOwnedByFirm": false,
"dateJoined": "2026-08-14T16:02:11.000Z",
"externalReference": "crm-10482"
}Retrying a client create
With the same `externalReference`, a retry never creates a second client. A retry sent while the first call is still running gets 409; wait a moment and send it again. A 503 means nothing was created, and the same call can be repeated. A reference on a deleted client is freed, so the next call creates a new client. Client creates share a per-minute limit with workspace creation in the app, plus a daily limit of 150.Keys limited to selected clients
A key limited to selected client workspaces only sees those clients in List client workspaces. The firm’s own workspace appears only if it was selected. It cannot create clients, because a new client could never be on its list.Related
Endpoints
/firm-partners/firm/detailsReturns the profile of the firm the API key belongs to.
/firm-partners/firm/clientsLists the client workspaces the firm manages, plus the firm’s own workspace.
/firm-partners/firm/clientsCreates a client workspace with its own books, owned and paid for by the firm.
/firm-partners/firm/membersLists the people on the firm’s team and their roles.
