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.

OpenAPI Spec

Guides Operations Schemas

GET OAuth Callback
Handles OAuth redirect with authorization code to exchange for tokens
/oauth/third-party/callback
GET List ThirdPartyConnections
Lists all ThirdPartyConnections for the given tenant. Requires: ViewAll on ThirdPartyConnections.
/tenants/{tenant}/connections
POST Create ThirdPartyConnection
Creates a new ThirdPartyConnection for the specified tenant. Requires: Create on ThirdPartyConnections.
/tenants/{tenant}/connections
GET Get ThirdPartyConnection
Gets a ThirdPartyConnection for the specified tenant. Requires: ViewAll on ThirdPartyConnections.
/tenants/{tenant}/connections/{code}
PUT Update ThirdPartyConnection
Updates a ThirdPartyConnection for the specified tenant. Requires: Update on ThirdPartyConnections.
/tenants/{tenant}/connections/{code}
DELETE Delete Third-Party Connection
Disconnects 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 Organization
If 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 Connection
Reconnects 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 Folder
Gets the base folder reference for a document storage connection, if one has been set. Requires: ViewAll on ThirdPartyConnections.
/tenants/{tenant}/connections/{code}/base-folder
PUT Set Base Folder
Creates or updates the base folder reference for a document storage connection. The connection must have the DocumentManagement capability. Requires:...
/tenants/{tenant}/connections/{code}/base-folder
GET Get Connection Credentials
Returns valid OAuth credentials for the connection, refreshing the token if expired. The connection must use OAuth authentication. Requires: ViewAll ...
/tenants/{tenant}/connections/{code}/auth-credentials
GET List Storage Locations
Lists 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 Folders
Lists 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