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 redirect endpointHandles 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 ThirdPartyConnectionDeletes a ThirdPartyConnection for the specified tenant./tenants/{tenant}/connections/{code}
-
POST Set OrrganizationIf 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
-
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