View as Markdown
Userflow icon

Userflow ACTION

Find User

Finds an existing user by user ID or email, optionally filtering by group ID. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Userflow 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: "userflow-find-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    userflow: { authProvisionId: "apn_xxxxxxx" },
    userId: "User ID",
    email: "Email",
  },
})

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
userId User ID string
The unique identifier for the user.
Optional Dynamic
email Email string
The user's email address.
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
userflow-find-user
Version
0.0.2
App
Userflow
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes