Query Pattern: Connections are accessed through the
Workspace type. Query workspaces, then access the connections field to get all provider connections.Arguments
The ID of the workspace to query connections for.
Optional filters to narrow down the connections returned.
Maximum number of connections to return.
Number of connections to skip for pagination.
Optional sorting configuration.
Returns
Unique identifier for the connection.
The provider key identifying the integration type (e.g.,
canopy, taxdome, karbon, google_drive, sharepoint).Current status of the connection. Common values include:
active- Connection is working and authenticatedpending- Connection setup is in progressfailed- Connection has failed or credentials are invaliddisconnected- Connection has been disconnected
The category of the provider. Common values include:
practice_management- Practice management systems (e.g., Canopy, TaxDome, Karbon)document_management- Document storage providers (e.g., Google Drive, SharePoint)tax_software- Tax preparation software (e.g., Drake, UltraTax, Lacerte)
Example
Additional Fields
TheProviderConnection type includes additional fields you can query:
Human-readable name for the connection.
Timestamp when the connection was created.
Timestamp when the connection was last updated.
Provider details including name and category.
Troubleshooting
Problem: No connections returned or empty list Solutions:- Verify the workspace ID is correct
- Check that connections have been set up for this workspace
- Review filters to ensure they aren’t excluding all connections
failed status
Solutions:
- The connection credentials may have expired or been revoked
- Re-authenticate the connection using start provider connection
- Check the provider’s settings or permissions
To set up a new connection, use start provider connection. To complete authentication, use collect provider connection.