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/

Request

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

client_query_idstring

Names the ClickHouse query this request runs. Send the same id to DELETE /api/projects/:project_id/query/:client_query_id/ to stop a search that is still running. Up to 128 characters.

distinct_idstring

Filter list by distinct id.

emailstring

Filter persons by email (exact match)

format'csv' | 'json'
include_matched_fieldsboolean

Tag each search result with matched_fields, the searched fields the term was found in. A complete email address that exactly matches a distinct ID then returns that person first, followed by every person whose email or name property contains the address.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

type'AND' | 'OR'

Filter Persons by person properties.

searchstring

Search persons by email, name, person ID, or distinct ID. Partial values match. When the term is a complete email address or UUID that exactly matches a distinct ID or person ID, only that person is returned.

Response

nextstring uri nullable
previousstring uri nullable
countinteger

Example response

{
  "next": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100",
  "previous": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100",
  "count": 400
}

Changes

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