View as Markdown
PostHog icon

PostHog ACTION

Get Persons

Retrieve a list of persons. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's PostHog account once, then configure and run Get Persons 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: "posthog-get-persons",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    posthog: { authProvisionId: "apn_xxxxxxx" },
    organizationId: "Organization ID",
    projectId: "Project ID",
  },
})

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 Persons inputs
Property Type Description
organizationId Organization ID string
Identifier of an organization
Required Dynamic
projectId Project ID string
Identifier of a project
Required Dynamic
email Email string
Filter persons by email (exact match)
Optional
search Search string
Search persons, either by email (full text search) or distinct_id (exact match)
Optional
maxResults Max Results integer
The maximum number of results to return
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
posthog-get-persons
Version
0.0.5
App
PostHog
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes