List Connections
Overview
list_connections lists the data source connections the current user already has — e.g. which providers, labs, or pharmacies they're connected to, and each connection's status. Call this tool when the user asks "what am I connected to?" or before deciding whether a new connection is needed. Unlike search_connections, this does not search a directory — it returns the user's own existing connections, scoped entirely to the caller via their auth token. No person/patient identifier parameter is needed or accepted.
Optional Parameters
status (array of strings)
- Default:
null - Filter to connections with one of these statuses:
CONNECTED,DISCONNECTED,ERROR,EXPIRED,DELETED,ACCESS_ENDED. Omit to return connections in any status.
sync_status (array of strings)
- Default:
null - Filter to connections with one of these data-retrieval sync statuses:
PENDING,RETRIEVING,RETRIEVED,ERROR,DELETING,DATA_DELETED. Omit to return connections with any sync status.
integration_type (array of strings)
- Default:
null - Filter to connections of one of these integration types, e.g.
DIRECT,PROA. Omit to return connections of any integration type.
Returns
A dictionary wrapping the underlying getMemberConnections GraphQL result, with a get_member_connections list. Each item has:
id— unique identifier for the connection.name— display name of the data source.category—BASIC,OAUTH, orIDENTITY.type—PRACTITIONER,CLINICAL,INSURANCE,LAB,PHARMACY, orDEVICE.is_direct— whether the connection is a direct (non-PROA) connection.integration_type— e.g.DIRECT,PROA(nullable).consent_policy_url— URL of the consent policy for this connection (nullable).consent_validity_duration— ISO 8601 duration (e.g.P1Y) for which member consent remains valid (nullable).endpoint_status— operational status of the endpoint (nullable).status—CONNECTED,DISCONNECTED,ERROR,EXPIRED,DELETED, orACCESS_ENDED(nullable).sync_status—PENDING,RETRIEVING,RETRIEVED,ERROR,DELETING, orDATA_DELETED(nullable).sync_errors— list of{id, text, coding: [{code, display, system}]}describing any sync errors (nullable).status_updated— datetime the status was last updated (nullable).last_synced— datetime of the last successful sync (nullable).created— datetime the connection was created.disconnect_url— URL to disconnect this connection (nullable).
Notes
This tool accesses the same underlying Connection data that create_connection creates. A connection may appear in results before clinical data retrieval completes. Review sync_status to determine whether data retrieval is ongoing (PENDING/RETRIEVING) or complete (RETRIEVED).
Updated 14 days ago
