View as Markdown
Universal API icon

Universal API ACTION

Get Connection

Retrieve a single connection identified by universalApi and serviceId from the Platform API on Universal API. Run List Connections first to find the correct serviceId. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Universal API 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: "universal_api-get-connection",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    universal_api: { authProvisionId: "apn_xxxxxxx" },
    consumerId: "Consumer ID",
    universalApi: "Universal API",
  },
})

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
consumerId Consumer ID string
The consumer ID. Run List Consumers first to find valid IDs.
Required
universalApi Universal API string
The Universal API to use.
Required
serviceId Service ID string
The service ID that, together with universalApi, identifies the connection (e.g. kandji, jamf, teamtailor).
Required

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
universal_api-get-connection
Version
0.0.2
App
Universal API
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes