Third-Party Connections
OAuth connections and integrations to third-party platforms (accounting systems, practice management tools, etc.). Provides CRUD operations for managing connections, an anonymous OAuth callback endpoint for handling authorization code exchanges, and an endpoint to set organization IDs for connections in Initialising status to activate them. Supports platforms like QuickBooks, Xero, and others with OAuth2 authentication.
-
GET OAuth CallbackHandles OAuth redirect with authorization code to exchange for tokens/oauth/third-party/callback
-
GET List ThirdPartyConnectionsLists all ThirdPartyConnections for the given tenant./tenants/{tenant}/connections
-
POST Create ThirdPartyConnectionCreates a new ThirdPartyConnection for the specified tenant./tenants/{tenant}/connections
-
GET Get ThirdPartyConnectionGets a ThirdPartyConnection for the specified tenant./tenants/{tenant}/connections/{code}
-
PUT Update ThirdPartyConnectionUpdates a ThirdPartyConnection for the specified tenant./tenants/{tenant}/connections/{code}
-
DELETE Delete Third-Party ConnectionDisconnects the connection: its credentials are cleared and it leaves the tenant's slot, but the connection and everything attached to it stay, so rec.../tenants/{tenant}/connections/{code}
-
POST Set OrganizationIf the ThirdPartyConnection has a status of "Initialising", then you need to use this endpoint to set the organization Id. The status will then become.../tenants/{tenant}/connections/{code}/set-organization
-
POST Reauthorise ConnectionReconnects an existing connection in place. On OAuth platforms it starts a fresh sign-in and returns the connection with a new authorisation URL to se.../tenants/{tenant}/connections/{code}/reauthorise
-
GET Get Base FolderGets the base folder reference for a document storage connection, if one has been set./tenants/{tenant}/connections/{code}/base-folder
-
PUT Set Base FolderCreates or updates the base folder reference for a document storage connection. The connection must have the DocumentManagement capability./tenants/{tenant}/connections/{code}/base-folder
-
GET Get Connection CredentialsReturns valid OAuth credentials for the connection, refreshing the token if expired. The connection must use OAuth authentication./tenants/{tenant}/connections/{code}/auth-credentials
-
GET List Storage LocationsLists storage locations (e.g. SharePoint sites and their document libraries) available through this connection. Uses cached data by default; pass `ref.../tenants/{tenant}/connections/{code}/storage-locations
-
GET List Connection FoldersLists subfolders for a document storage connection. Pass `parentFolderId` to drill into a specific folder; omit it to list the connection's root folde.../tenants/{tenant}/connections/{code}/folders