persons
persons

Get person properties as they existed at a specific point in time.

This endpoint reconstructs person properties by querying ClickHouse events for $set and $set_once operations up to the specified timestamp.

Query parameters:

  • distinct_id: The distinct_id of the person
  • timestamp: ISO datetime string for the point in time (e.g., "2023-06-15T14:30:00Z")
  • include_set_once: Whether to handle $set_once operations (default: false)
get/api/projects/{project_id}/persons/properties_at_time/

Request

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

Path parameters

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

distinct_idstring

The distinct_id of the person (mutually exclusive with person_id)

format'csv' | 'json'
include_set_onceboolean

Whether to handle $set_once operations (default: false)

person_idstring

The person_id (UUID) to build properties for (mutually exclusive with distinct_id)

timestampstring required

ISO datetime string for the point in time (e.g., '2023-06-15T14:30:00Z')

Response

idinteger required

The person ID

namestring required

The person's display name

distinct_idsstring[] required

All distinct IDs associated with this person

propertiesobject required

Person properties as they existed at the specified time

created_atstring date-time required

When the person was first created

uuidstring uuid required

The person's UUID

last_seen_atstring date-time nullable required

When the person was last seen

Changes

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