View as Markdown
Nango icon

Nango ACTION

Get Connection

Returns a Connection. See the Documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Nango account once, then configure and run Get Connection from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "nango-get-connection",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    nango: { authProvisionId: "apn_xxxxxxx" },
    connectionId: "Connection ID",
    providerConfigKey: "Provider Config Key",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Connection inputs
Property Type Description
connectionId Connection ID string
The Connection ID of the Integration.
Required Dynamic
providerConfigKey Provider Config Key string
The Provider Config Key of the connection.
Required Dynamic
forceRefresh Force Refresh boolean
Force a refresh of the Connection.
Optional
refreshToken Refresh Token string
The Refresh Token of the Connection.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
nango-get-connection
Version
0.0.2
App
Nango
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes