Read a Connection
GET /v1/connections/{connection_id}
Property Value Operation get_connectionGroup Connections Scope integrations:readRoute class readIdempotency No Idempotency-Key Audit Not audited: A configuration read; a Connection is not Call content and its secrets are never answered. Released in 1.60.0 Phase 0 host Served (the hosted api pins 1.65.0)
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the integrations:read scope (Authentication and keys ). Replace each placeholder, such as agt_... or <name>, with your own value.
cURL Node.js Python
curl "$VOCAL_API/v1/connections/con_..." \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/connections/con_...`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/connections/con_...",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
Name In Type Required Description connection_idpath ConnectionId yes The id of a Connection: con_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
Responses
Fields of the 200 answer
The shape is Connection .
Field Type Required Description allowed_environmentsarray of Environment yes The environments whose runs may use it; live only by default. A test run against a Connection that does not allow test executes the Connector's mock (integrations.md section 3). auth_strategyConnectionAuthStrategy yes authorized_atTimestamp or nullyes base_urlConnectionBaseUrl or nullyes connector_idConnectorId or nullyes The Connector; null for an MCP server. connector_majorinteger or null yes The major version of the Connector's manifest the Connection pins; null for an MCP server. created_atTimestamp yes enabled_toolsarray of ConnectorToolName yes The Connector's tools the Organization allows, which set the scopes requested (integrations.md section 10); empty for an MCP server, whose registration's allowed_tools govern. external_accountstring or null yes The external account authorized (a tenant id, an instance URL); null before. granted_scopesarray of VendorScope yes The scopes the vendor granted at the last authorization; empty before. idConnectionId yes mcp_server_idMcpServerId or nullyes The MCP server registration whose credential the Connection holds; null for a Connector. nameConnectionName yes object"connection"yes organization_idOrganizationId yes originConnectionOrigin yes phi_attestationConnectionPhiAttestation or nullyes The PHI attestation, or null; only an attested Connection may receive PHI. requested_scopesarray of VendorScope yes The union of the scopes of enabled_tools; nothing more is requested. revisioninteger yes Counts writes to the Connection; returned as the ETag and required in If-Match. revoked_atTimestamp or nullyes sandboxboolean yes True for a vendor sandbox, which may allow test; a test Call never books a real appointment. secret_hintstring or null yes The last characters of the stored key or token, or null; never the secret. secret_versioninteger yes Counts the secrets stored; 0 before the first. A refresh write-back compares and sets it. senderConnectionSender or nullyes The sender of a messaging Connection; null otherwise. statusConnectionStatus yes status_reasonConnectionStatusReason or nullyes Null while active. updated_atTimestamp yes