provider persons GET /api/environments/{environment_id}/persons/{id}/emails/
@utdk/posthog /api/environments/{environment_id}/persons/{id}/emails/
environments_persons_emails_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.
after query
Start of the time range, matched on sent time. Relative ('-30d', '-24h') or ISO 8601. Defaults to -30d (the retention window) — bounds the ClickHouse partition scan.
string
before query
End of the time range, matched on sent time. Same format as 'after'. Defaults to now.
string
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string
format query
enum: csv, json
id path required
A unique integer value identifying this person.
integer
limit query
Maximum number of emails to return (1-500, default 50).
integer
offset query
Number of emails to skip, for pagination.
integer

Try it

Authentication
Configure credentials for PostHog API
environmentsPersonsEmailsList
GET/api/environments/{environment_id}/persons/{id}/emails/
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

A unique integer value identifying this person.

Start of the time range, matched on sent time. Relative ('-30d', '-24h') or ISO 8601. Defaults to -30d (the retention window) — bounds the ClickHouse partition scan.

End of the time range, matched on sent time. Same format as 'after'. Defaults to now.

Maximum number of emails to return (1-500, default 50).

Number of emails to skip, for pagination.

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.environmentsPersonsEmailsList({
  "after": "-30d",
  "limit": 50,
  "offset": 0
})