persons

This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the capture API, the $set and $unset properties, or one of our SDKs.

get/api/projects/{project_id}/persons/{id}/emails/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/persons/{id}/emails/
  • Auth: HTTP bearer

Path parameters

idinteger required

A unique integer value identifying this person.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

afterstring

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.

beforestring

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

format'csv' | 'json'
limitinteger

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

offsetinteger

Number of assets to skip, for pagination.

Response

invocation_idstring required

The workflow run this email was sent in.

action_idstring required

The email step (action node) within the workflow that sent this email.

function_idstring required

The workflow id that sent this email — used to navigate from a person's Emails tab back into the originating workflow.

function_namestring required

Human-readable workflow name for display. Empty when the workflow has been deleted; clients should fall back to function_id in that case.

parent_run_idstring required

The batch run this email belongs to, for batch-triggered workflows. Empty for event-triggered runs.

kindstring required

Message channel this asset was sent on: 'email' or 'push'. The per-person endpoints return one channel each.

distinct_idstring required

The recipient's distinct_id.

person_idstring required

The recipient's person UUID, if resolved.

recipientstring required

Who the message went to: the email address for 'email', or the recipient's distinct ID for 'push'.

subjectstring required

The email subject line, or the push notification title.

statusstring required

Delivery status at capture time. Currently always 'sent' - only delivered messages are captured.

sent_atstring date-time required

When the message was sent.

Changes

No recorded changes to this operation across all 1 revision of this API.