provider persons GET /api/environments/{environment_id}/persons/values/
@utdk/posthog /api/environments/{environment_id}/persons/values/
environments_persons_values_retrieve
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.
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string
format query
enum: csv, json
key query required
The person property key to get values for (e.g., 'email', 'plan', 'role').
string
value query
Optional search string to filter values (case-insensitive substring match).
string

Try it

Authentication
Configure credentials for PostHog API
environmentsPersonsValuesRetrieve
GET/api/environments/{environment_id}/persons/values/
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.

required

The person property key to get values for (e.g., 'email', 'plan', 'role').

Optional search string to filter values (case-insensitive substring 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.environmentsPersonsValuesRetrieve()