View as Markdown
Amplitude icon

Amplitude ACTION

Search Users

Look up Amplitude users by Amplitude ID, Device ID, User ID, or a User ID prefix. Use this before Get User Activity to resolve a user's amplitude_id. Example: call with user="user@example.com" -> returns {matches: [{amplitude_id: 12345678, user_id: "user@example.com"}], type: "user_id"}. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Amplitude account once, then configure and run Search Users 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: "amplitude-search-users",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    amplitude: { authProvisionId: "apn_xxxxxxx" },
    user: "User",
  },
})

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.

Search Users inputs
Property Type Description
user User string
A free-form user identifier (the user param): an Amplitude ID, Device ID, User ID, or a User ID prefix. Example: user@example.com.
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
amplitude-search-users
Version
0.0.2
App
Amplitude
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes