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.

post/api/projects/{project_id}/persons/batch_by_uuids/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/persons/batch_by_uuids/
  • 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

format'csv' | 'json'

Request body

idinteger required

Numeric person ID.

namestring required

Display name derived from person properties (email, name, or username).

distinct_idsstring[] required
propertiesunknown
created_atstring date-time required

When this person was first seen (ISO 8601).

uuidstring uuid required

Unique identifier (UUID) for this person.

last_seen_atstring date-time nullable required

Timestamp of the last event from this person, or null.

Response

No response body

Changes

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