`get_persons`

Pack: posthog · Endpoint: https://gateway.pipeworx.io/posthog/mcp

Search for persons (users) in a PostHog project. Returns user profiles with properties. Example: get_persons({ project_id: “12345”, search: “[email protected]”, apiKey: “phx…” })

Parameters

Name	Type	Required	Description
`project_id`	string	yes	PostHog project ID (numeric string)
`search`	string	no	Optional search query to filter persons by email, name, or distinct ID
`_apiKey`	string	yes	PostHog personal API key (phx_…)

Example call

Arguments

{
  "project_id": "12345",
  "search": "[email protected]",
  "_apiKey": "your-posthog-api-key"
}

curl

curl -X POST https://gateway.pipeworx.io/posthog/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"get_persons","arguments":{"project_id":"12345","search":"[email protected]","_apiKey":"your-posthog-api-key"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('get_persons', {
  "project_id": "12345",
  "search": "[email protected]",
  "_apiKey": "your-posthog-api-key"
});

More examples

{
  "project_id": "12345",
  "_apiKey": "your-posthog-api-key"
}

Response shape

Full JSON Schema

{
  "type": "object",
  "description": "Persons (users) from a PostHog project"
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "posthog": {
      "url": "https://gateway.pipeworx.io/posthog/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

get_persons