View as Markdown
Pipeline icon

Pipeline ACTION

Find User

Find an existing user on your Pipeline account. See the docs here
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Pipeline account once, then configure and run Find User 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: "pipeline-find-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pipeline: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    admin: true,
  },
})

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.

Find User inputs
Property Type Description
email Email string
Find a user with the exact email
Optional
admin Admin boolean
Return only account administrators
Optional
includingInactive Include Inactive boolean
Return all users, including inactive ones (default returns only active)
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
pipeline-find-user
Version
0.0.2
App
Pipeline
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes