provider persons GET /api/environments/{environment_id}/persons/
@utdk/posthog /api/environments/{environment_id}/persons/
environments_persons_list
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
distinct_id query
Filter list by distinct id.
string
email query
Filter persons by email (exact match)
string
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string
format query
enum: csv, json
limit query
Number of results to return per page.
integer
offset query
The initial index from which to return the results.
integer
properties query
Filter Persons by person properties.
array
search query
Search persons, either by email (full text search) or distinct_id (exact match).
string

Try it

Authentication
Configure credentials for PostHog API
environmentsPersonsList
GET/api/environments/{environment_id}/persons/
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.

Parameters

required

Deprecated. Use /api/projects/{project_id}/ instead.

Filter list by distinct id.

Filter persons by email (exact match)

Number of results to return per page.

The initial index from which to return the results.

Filter Persons by person properties.

Search persons, either by email (full text search) or distinct_id (exact match).

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.environmentsPersonsList()