naftiko: 1.0.0-alpha2 info: label: PostHog API — persons description: 'PostHog API — persons. 96 operations. Lead operation: persons. Self-contained Naftiko capability covering one Posthog business surface.' tags: - Posthog - persons created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: POSTHOG_API_KEY: POSTHOG_API_KEY capability: consumes: - type: http namespace: posthog-persons baseUri: '' description: PostHog API — persons business capability. Self-contained, no shared references. resources: - name: api-environments-environment_id-persons path: /api/environments/{environment_id}/persons/ operations: - name: environmentspersonslist method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: distinct_id in: query type: string description: Filter list by distinct id. - name: email in: query type: string description: Filter persons by email (exact match) - name: format in: query type: string - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. - name: properties in: query type: array description: Filter Persons by person properties. - name: search in: query type: string description: Search persons, either by email (full text search) or distinct_id (exact match). - name: environmentspersonslist method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: distinct_id in: query type: string description: Filter list by distinct id. - name: email in: query type: string description: Filter persons by email (exact match) - name: format in: query type: string - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. - name: properties in: query type: array description: Filter Persons by person properties. - name: search in: query type: string description: Search persons, either by email (full text search) or distinct_id (exact match). - name: api-environments-environment_id-persons-activity path: /api/environments/{environment_id}/persons/activity/ operations: - name: environmentspersonsallactivityretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: environmentspersonsallactivityretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: api-environments-environment_id-persons-batch_by_distinct_ids path: /api/environments/{environment_id}/persons/batch_by_distinct_ids/ operations: - name: environmentspersonsbatchbydistinctidscreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: environmentspersonsbatchbydistinctidscreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: api-environments-environment_id-persons-batch_by_uuids path: /api/environments/{environment_id}/persons/batch_by_uuids/ operations: - name: environmentspersonsbatchbyuuidscreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: environmentspersonsbatchbyuuidscreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: api-environments-environment_id-persons-bulk_delete path: /api/environments/{environment_id}/persons/bulk_delete/ operations: - name: environmentspersonsbulkdeletecreate method: POST description: This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: environmentspersonsbulkdeletecreate method: POST description: This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: api-environments-environment_id-persons-cohorts path: /api/environments/{environment_id}/persons/cohorts/ operations: - name: environmentspersonscohortsretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: person_id in: query type: string description: The person ID or UUID to get cohorts for. required: true - name: environmentspersonscohortsretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: person_id in: query type: string description: The person ID or UUID to get cohorts for. required: true - name: api-environments-environment_id-persons-deletion_status path: /api/environments/{environment_id}/persons/deletion_status/ operations: - name: environmentspersonsdeletionstatuslist method: GET description: List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. - name: person_uuid in: query type: string description: Filter by a specific person UUID. - name: status in: query type: string description: 'Filter by deletion status: ''pending'', ''completed'', or ''all''.' - name: environmentspersonsdeletionstatuslist method: GET description: List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. - name: person_uuid in: query type: string description: Filter by a specific person UUID. - name: status in: query type: string description: 'Filter by deletion status: ''pending'', ''completed'', or ''all''.' - name: api-environments-environment_id-persons-funnel path: /api/environments/{environment_id}/persons/funnel/ operations: - name: environmentspersonsfunnelretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: environmentspersonsfunnelretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: environmentspersonsfunnelcreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: environmentspersonsfunnelcreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: api-environments-environment_id-persons-funnel-correlation path: /api/environments/{environment_id}/persons/funnel/correlation/ operations: - name: environmentspersonsfunnelcorrelationretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: environmentspersonsfunnelcorrelationretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: environmentspersonsfunnelcorrelationcreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: environmentspersonsfunnelcorrelationcreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: api-environments-environment_id-persons-lifecycle path: /api/environments/{environment_id}/persons/lifecycle/ operations: - name: environmentspersonslifecycleretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: environmentspersonslifecycleretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: api-environments-environment_id-persons-properties_at_time path: /api/environments/{environment_id}/persons/properties_at_time/ operations: - name: environmentspersonspropertiesattimeretrieve method: GET description: Get person properties as they existed at a specific point in time. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: debug in: query type: boolean description: 'Whether to include debug information with raw events (only works when DEBUG=True, default: false)' - name: distinct_id in: query type: string description: The distinct_id of the person (mutually exclusive with person_id) - name: format in: query type: string - name: include_set_once in: query type: boolean description: 'Whether to handle $set_once operations (default: false)' - name: person_id in: query type: string description: The person_id (UUID) to build properties for (mutually exclusive with distinct_id) - name: timestamp in: query type: string description: ISO datetime string for the point in time (e.g., '2023-06-15T14:30:00Z') required: true - name: environmentspersonspropertiesattimeretrieve method: GET description: Get person properties as they existed at a specific point in time. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: debug in: query type: boolean description: 'Whether to include debug information with raw events (only works when DEBUG=True, default: false)' - name: distinct_id in: query type: string description: The distinct_id of the person (mutually exclusive with person_id) - name: format in: query type: string - name: include_set_once in: query type: boolean description: 'Whether to handle $set_once operations (default: false)' - name: person_id in: query type: string description: The person_id (UUID) to build properties for (mutually exclusive with distinct_id) - name: timestamp in: query type: string description: ISO datetime string for the point in time (e.g., '2023-06-15T14:30:00Z') required: true - name: api-environments-environment_id-persons-reset_person_distinct_id path: /api/environments/{environment_id}/persons/reset_person_distinct_id/ operations: - name: environmentspersonsresetpersondistinctidcreate method: POST description: Reset a distinct_id for a deleted person. This allows the distinct_id to be used again. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: environmentspersonsresetpersondistinctidcreate method: POST description: Reset a distinct_id for a deleted person. This allows the distinct_id to be used again. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: api-environments-environment_id-persons-trends path: /api/environments/{environment_id}/persons/trends/ operations: - name: environmentspersonstrendsretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: environmentspersonstrendsretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: api-environments-environment_id-persons-values path: /api/environments/{environment_id}/persons/values/ operations: - name: environmentspersonsvaluesretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: key in: query type: string description: The person property key to get values for (e.g., 'email', 'plan', 'role'). required: true - name: value in: query type: string description: Optional search string to filter values (case-insensitive substring match). - name: environmentspersonsvaluesretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: key in: query type: string description: The person property key to get values for (e.g., 'email', 'plan', 'role'). required: true - name: value in: query type: string description: Optional search string to filter values (case-insensitive substring match). - name: api-environments-environment_id-persons-id path: /api/environments/{environment_id}/persons/{id}/ operations: - name: environmentspersonsretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: environmentspersonsretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: environmentspersonsupdate method: PUT description: Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: environmentspersonsupdate method: PUT description: Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: environmentspersonspartialupdate method: PATCH description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: environmentspersonspartialupdate method: PATCH description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: api-environments-environment_id-persons-id-activity path: /api/environments/{environment_id}/persons/{id}/activity/ operations: - name: environmentspersonsactivityretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this person. required: true - name: environmentspersonsactivityretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this person. required: true - name: api-environments-environment_id-persons-id-delete_property path: /api/environments/{environment_id}/persons/{id}/delete_property/ operations: - name: environmentspersonsdeletepropertycreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: environmentspersonsdeletepropertycreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: api-environments-environment_id-persons-id-properties_timeline path: /api/environments/{environment_id}/persons/{id}/properties_timeline/ operations: - name: environmentspersonspropertiestimelineretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this person. required: true - name: environmentspersonspropertiestimelineretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this person. required: true - name: api-environments-environment_id-persons-id-split path: /api/environments/{environment_id}/persons/{id}/split/ operations: - name: environmentspersonssplitcreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this person. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: environmentspersonssplitcreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this person. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: api-environments-environment_id-persons-id-update_property path: /api/environments/{environment_id}/persons/{id}/update_property/ operations: - name: environmentspersonsupdatepropertycreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: environmentspersonsupdatepropertycreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: api-projects-project_id-persons path: /api/projects/{project_id}/persons/ operations: - name: personslist method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: distinct_id in: query type: string description: Filter list by distinct id. - name: email in: query type: string description: Filter persons by email (exact match) - name: format in: query type: string - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. - name: properties in: query type: array description: Filter Persons by person properties. - name: search in: query type: string description: Search persons, either by email (full text search) or distinct_id (exact match). - name: personslist method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: distinct_id in: query type: string description: Filter list by distinct id. - name: email in: query type: string description: Filter persons by email (exact match) - name: format in: query type: string - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. - name: properties in: query type: array description: Filter Persons by person properties. - name: search in: query type: string description: Search persons, either by email (full text search) or distinct_id (exact match). - name: api-projects-project_id-persons-activity path: /api/projects/{project_id}/persons/activity/ operations: - name: personsallactivityretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: personsallactivityretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: api-projects-project_id-persons-batch_by_distinct_ids path: /api/projects/{project_id}/persons/batch_by_distinct_ids/ operations: - name: personsbatchbydistinctidscreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: personsbatchbydistinctidscreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: api-projects-project_id-persons-batch_by_uuids path: /api/projects/{project_id}/persons/batch_by_uuids/ operations: - name: personsbatchbyuuidscreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: personsbatchbyuuidscreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: api-projects-project_id-persons-bulk_delete path: /api/projects/{project_id}/persons/bulk_delete/ operations: - name: personsbulkdeletecreate method: POST description: This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: personsbulkdeletecreate method: POST description: This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: api-projects-project_id-persons-cohorts path: /api/projects/{project_id}/persons/cohorts/ operations: - name: personscohortsretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: person_id in: query type: string description: The person ID or UUID to get cohorts for. required: true - name: personscohortsretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: person_id in: query type: string description: The person ID or UUID to get cohorts for. required: true - name: api-projects-project_id-persons-deletion_status path: /api/projects/{project_id}/persons/deletion_status/ operations: - name: personsdeletionstatuslist method: GET description: List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. - name: person_uuid in: query type: string description: Filter by a specific person UUID. - name: status in: query type: string description: 'Filter by deletion status: ''pending'', ''completed'', or ''all''.' - name: personsdeletionstatuslist method: GET description: List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. - name: person_uuid in: query type: string description: Filter by a specific person UUID. - name: status in: query type: string description: 'Filter by deletion status: ''pending'', ''completed'', or ''all''.' - name: api-projects-project_id-persons-funnel path: /api/projects/{project_id}/persons/funnel/ operations: - name: personsfunnelretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: personsfunnelretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: personsfunnelcreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: personsfunnelcreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: api-projects-project_id-persons-funnel-correlation path: /api/projects/{project_id}/persons/funnel/correlation/ operations: - name: personsfunnelcorrelationretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: personsfunnelcorrelationretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: personsfunnelcorrelationcreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: personsfunnelcorrelationcreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: api-projects-project_id-persons-lifecycle path: /api/projects/{project_id}/persons/lifecycle/ operations: - name: personslifecycleretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: personslifecycleretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: api-projects-project_id-persons-properties_at_time path: /api/projects/{project_id}/persons/properties_at_time/ operations: - name: personspropertiesattimeretrieve method: GET description: Get person properties as they existed at a specific point in time. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: debug in: query type: boolean description: 'Whether to include debug information with raw events (only works when DEBUG=True, default: false)' - name: distinct_id in: query type: string description: The distinct_id of the person (mutually exclusive with person_id) - name: format in: query type: string - name: include_set_once in: query type: boolean description: 'Whether to handle $set_once operations (default: false)' - name: person_id in: query type: string description: The person_id (UUID) to build properties for (mutually exclusive with distinct_id) - name: timestamp in: query type: string description: ISO datetime string for the point in time (e.g., '2023-06-15T14:30:00Z') required: true - name: personspropertiesattimeretrieve method: GET description: Get person properties as they existed at a specific point in time. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: debug in: query type: boolean description: 'Whether to include debug information with raw events (only works when DEBUG=True, default: false)' - name: distinct_id in: query type: string description: The distinct_id of the person (mutually exclusive with person_id) - name: format in: query type: string - name: include_set_once in: query type: boolean description: 'Whether to handle $set_once operations (default: false)' - name: person_id in: query type: string description: The person_id (UUID) to build properties for (mutually exclusive with distinct_id) - name: timestamp in: query type: string description: ISO datetime string for the point in time (e.g., '2023-06-15T14:30:00Z') required: true - name: api-projects-project_id-persons-reset_person_distinct_id path: /api/projects/{project_id}/persons/reset_person_distinct_id/ operations: - name: personsresetpersondistinctidcreate method: POST description: Reset a distinct_id for a deleted person. This allows the distinct_id to be used again. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: personsresetpersondistinctidcreate method: POST description: Reset a distinct_id for a deleted person. This allows the distinct_id to be used again. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: body in: body type: object description: Request body (JSON). required: false - name: api-projects-project_id-persons-trends path: /api/projects/{project_id}/persons/trends/ operations: - name: personstrendsretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: personstrendsretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: api-projects-project_id-persons-values path: /api/projects/{project_id}/persons/values/ operations: - name: personsvaluesretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: key in: query type: string description: The person property key to get values for (e.g., 'email', 'plan', 'role'). required: true - name: value in: query type: string description: Optional search string to filter values (case-insensitive substring match). - name: personsvaluesretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: key in: query type: string description: The person property key to get values for (e.g., 'email', 'plan', 'role'). required: true - name: value in: query type: string description: Optional search string to filter values (case-insensitive substring match). - name: api-projects-project_id-persons-id path: /api/projects/{project_id}/persons/{id}/ operations: - name: personsretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: personsretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: personsupdate method: PUT description: Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: personsupdate method: PUT description: Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: personspartialupdate method: PATCH description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: personspartialupdate method: PATCH description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: api-projects-project_id-persons-id-activity path: /api/projects/{project_id}/persons/{id}/activity/ operations: - name: personsactivityretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this person. required: true - name: personsactivityretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this person. required: true - name: api-projects-project_id-persons-id-delete_property path: /api/projects/{project_id}/persons/{id}/delete_property/ operations: - name: personsdeletepropertycreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: personsdeletepropertycreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: api-projects-project_id-persons-id-properties_timeline path: /api/projects/{project_id}/persons/{id}/properties_timeline/ operations: - name: personspropertiestimelineretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this person. required: true - name: personspropertiestimelineretrieve method: GET description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this person. required: true - name: api-projects-project_id-persons-id-split path: /api/projects/{project_id}/persons/{id}/split/ operations: - name: personssplitcreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this person. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: personssplitcreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: integer description: A unique integer value identifying this person. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: api-projects-project_id-persons-id-update_property path: /api/projects/{project_id}/persons/{id}/update_property/ operations: - name: personsupdatepropertycreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: personsupdatepropertycreate method: POST description: 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-analytic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: format in: query type: string - name: id in: path type: string description: A unique value identifying this person. Accepts both numeric ID and UUID. required: true - name: body in: body type: object description: Request body (JSON). required: true authentication: type: bearer token: '{{env.POSTHOG_API_KEY}}' exposes: - type: rest namespace: posthog-persons-rest port: 8080 description: REST adapter for PostHog API — persons. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/api/environments/{environment-id}/persons name: api-environments-environment-id-persons description: REST surface for api-environments-environment_id-persons. operations: - method: GET name: environmentspersonslist description: 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-analytic call: posthog-persons.environmentspersonslist with: distinct_id: rest.distinct_id email: rest.email format: rest.format limit: rest.limit offset: rest.offset properties: rest.properties search: rest.search outputParameters: - type: object mapping: $. - method: GET name: environmentspersonslist description: 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-analytic call: posthog-persons.environmentspersonslist with: distinct_id: rest.distinct_id email: rest.email format: rest.format limit: rest.limit offset: rest.offset properties: rest.properties search: rest.search outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/activity name: api-environments-environment-id-persons-activity description: REST surface for api-environments-environment_id-persons-activity. operations: - method: GET name: environmentspersonsallactivityretrieve description: 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-analytic call: posthog-persons.environmentspersonsallactivityretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: GET name: environmentspersonsallactivityretrieve description: 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-analytic call: posthog-persons.environmentspersonsallactivityretrieve with: format: rest.format outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/batch-by-distinct-ids name: api-environments-environment-id-persons-batch-by-distinct-ids description: REST surface for api-environments-environment_id-persons-batch_by_distinct_ids. operations: - method: POST name: environmentspersonsbatchbydistinctidscreate description: 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-analytic call: posthog-persons.environmentspersonsbatchbydistinctidscreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - method: POST name: environmentspersonsbatchbydistinctidscreate description: 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-analytic call: posthog-persons.environmentspersonsbatchbydistinctidscreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/batch-by-uuids name: api-environments-environment-id-persons-batch-by-uuids description: REST surface for api-environments-environment_id-persons-batch_by_uuids. operations: - method: POST name: environmentspersonsbatchbyuuidscreate description: 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-analytic call: posthog-persons.environmentspersonsbatchbyuuidscreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - method: POST name: environmentspersonsbatchbyuuidscreate description: 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-analytic call: posthog-persons.environmentspersonsbatchbyuuidscreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/bulk-delete name: api-environments-environment-id-persons-bulk-delete description: REST surface for api-environments-environment_id-persons-bulk_delete. operations: - method: POST name: environmentspersonsbulkdeletecreate description: This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted. call: posthog-persons.environmentspersonsbulkdeletecreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - method: POST name: environmentspersonsbulkdeletecreate description: This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted. call: posthog-persons.environmentspersonsbulkdeletecreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/cohorts name: api-environments-environment-id-persons-cohorts description: REST surface for api-environments-environment_id-persons-cohorts. operations: - method: GET name: environmentspersonscohortsretrieve description: 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-analytic call: posthog-persons.environmentspersonscohortsretrieve with: format: rest.format person_id: rest.person_id outputParameters: - type: object mapping: $. - method: GET name: environmentspersonscohortsretrieve description: 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-analytic call: posthog-persons.environmentspersonscohortsretrieve with: format: rest.format person_id: rest.person_id outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/deletion-status name: api-environments-environment-id-persons-deletion-status description: REST surface for api-environments-environment_id-persons-deletion_status. operations: - method: GET name: environmentspersonsdeletionstatuslist description: List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed. call: posthog-persons.environmentspersonsdeletionstatuslist with: format: rest.format limit: rest.limit offset: rest.offset person_uuid: rest.person_uuid status: rest.status outputParameters: - type: object mapping: $. - method: GET name: environmentspersonsdeletionstatuslist description: List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed. call: posthog-persons.environmentspersonsdeletionstatuslist with: format: rest.format limit: rest.limit offset: rest.offset person_uuid: rest.person_uuid status: rest.status outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/funnel name: api-environments-environment-id-persons-funnel description: REST surface for api-environments-environment_id-persons-funnel. operations: - method: GET name: environmentspersonsfunnelretrieve description: 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-analytic call: posthog-persons.environmentspersonsfunnelretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: GET name: environmentspersonsfunnelretrieve description: 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-analytic call: posthog-persons.environmentspersonsfunnelretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: POST name: environmentspersonsfunnelcreate description: 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-analytic call: posthog-persons.environmentspersonsfunnelcreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - method: POST name: environmentspersonsfunnelcreate description: 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-analytic call: posthog-persons.environmentspersonsfunnelcreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/funnel/correlation name: api-environments-environment-id-persons-funnel-correlation description: REST surface for api-environments-environment_id-persons-funnel-correlation. operations: - method: GET name: environmentspersonsfunnelcorrelationretrieve description: 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-analytic call: posthog-persons.environmentspersonsfunnelcorrelationretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: GET name: environmentspersonsfunnelcorrelationretrieve description: 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-analytic call: posthog-persons.environmentspersonsfunnelcorrelationretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: POST name: environmentspersonsfunnelcorrelationcreate description: 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-analytic call: posthog-persons.environmentspersonsfunnelcorrelationcreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - method: POST name: environmentspersonsfunnelcorrelationcreate description: 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-analytic call: posthog-persons.environmentspersonsfunnelcorrelationcreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/lifecycle name: api-environments-environment-id-persons-lifecycle description: REST surface for api-environments-environment_id-persons-lifecycle. operations: - method: GET name: environmentspersonslifecycleretrieve description: 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-analytic call: posthog-persons.environmentspersonslifecycleretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: GET name: environmentspersonslifecycleretrieve description: 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-analytic call: posthog-persons.environmentspersonslifecycleretrieve with: format: rest.format outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/properties-at-time name: api-environments-environment-id-persons-properties-at-time description: REST surface for api-environments-environment_id-persons-properties_at_time. operations: - method: GET name: environmentspersonspropertiesattimeretrieve description: Get person properties as they existed at a specific point in time. call: posthog-persons.environmentspersonspropertiesattimeretrieve with: debug: rest.debug distinct_id: rest.distinct_id format: rest.format include_set_once: rest.include_set_once person_id: rest.person_id timestamp: rest.timestamp outputParameters: - type: object mapping: $. - method: GET name: environmentspersonspropertiesattimeretrieve description: Get person properties as they existed at a specific point in time. call: posthog-persons.environmentspersonspropertiesattimeretrieve with: debug: rest.debug distinct_id: rest.distinct_id format: rest.format include_set_once: rest.include_set_once person_id: rest.person_id timestamp: rest.timestamp outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/reset-person-distinct-id name: api-environments-environment-id-persons-reset-person-distinct-id description: REST surface for api-environments-environment_id-persons-reset_person_distinct_id. operations: - method: POST name: environmentspersonsresetpersondistinctidcreate description: Reset a distinct_id for a deleted person. This allows the distinct_id to be used again. call: posthog-persons.environmentspersonsresetpersondistinctidcreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - method: POST name: environmentspersonsresetpersondistinctidcreate description: Reset a distinct_id for a deleted person. This allows the distinct_id to be used again. call: posthog-persons.environmentspersonsresetpersondistinctidcreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/trends name: api-environments-environment-id-persons-trends description: REST surface for api-environments-environment_id-persons-trends. operations: - method: GET name: environmentspersonstrendsretrieve description: 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-analytic call: posthog-persons.environmentspersonstrendsretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: GET name: environmentspersonstrendsretrieve description: 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-analytic call: posthog-persons.environmentspersonstrendsretrieve with: format: rest.format outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/values name: api-environments-environment-id-persons-values description: REST surface for api-environments-environment_id-persons-values. operations: - method: GET name: environmentspersonsvaluesretrieve description: 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-analytic call: posthog-persons.environmentspersonsvaluesretrieve with: format: rest.format key: rest.key value: rest.value outputParameters: - type: object mapping: $. - method: GET name: environmentspersonsvaluesretrieve description: 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-analytic call: posthog-persons.environmentspersonsvaluesretrieve with: format: rest.format key: rest.key value: rest.value outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/{id} name: api-environments-environment-id-persons-id description: REST surface for api-environments-environment_id-persons-id. operations: - method: GET name: environmentspersonsretrieve description: 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-analytic call: posthog-persons.environmentspersonsretrieve with: format: rest.format id: rest.id outputParameters: - type: object mapping: $. - method: GET name: environmentspersonsretrieve description: 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-analytic call: posthog-persons.environmentspersonsretrieve with: format: rest.format id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: environmentspersonsupdate description: Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. call: posthog-persons.environmentspersonsupdate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: environmentspersonsupdate description: Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. call: posthog-persons.environmentspersonsupdate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: environmentspersonspartialupdate description: 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-analytic call: posthog-persons.environmentspersonspartialupdate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: environmentspersonspartialupdate description: 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-analytic call: posthog-persons.environmentspersonspartialupdate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/{id}/activity name: api-environments-environment-id-persons-id-activity description: REST surface for api-environments-environment_id-persons-id-activity. operations: - method: GET name: environmentspersonsactivityretrieve description: 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-analytic call: posthog-persons.environmentspersonsactivityretrieve with: format: rest.format id: rest.id outputParameters: - type: object mapping: $. - method: GET name: environmentspersonsactivityretrieve description: 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-analytic call: posthog-persons.environmentspersonsactivityretrieve with: format: rest.format id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/{id}/delete-property name: api-environments-environment-id-persons-id-delete-property description: REST surface for api-environments-environment_id-persons-id-delete_property. operations: - method: POST name: environmentspersonsdeletepropertycreate description: 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-analytic call: posthog-persons.environmentspersonsdeletepropertycreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: POST name: environmentspersonsdeletepropertycreate description: 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-analytic call: posthog-persons.environmentspersonsdeletepropertycreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/{id}/properties-timeline name: api-environments-environment-id-persons-id-properties-timeline description: REST surface for api-environments-environment_id-persons-id-properties_timeline. operations: - method: GET name: environmentspersonspropertiestimelineretrieve description: 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-analytic call: posthog-persons.environmentspersonspropertiestimelineretrieve with: format: rest.format id: rest.id outputParameters: - type: object mapping: $. - method: GET name: environmentspersonspropertiestimelineretrieve description: 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-analytic call: posthog-persons.environmentspersonspropertiestimelineretrieve with: format: rest.format id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/{id}/split name: api-environments-environment-id-persons-id-split description: REST surface for api-environments-environment_id-persons-id-split. operations: - method: POST name: environmentspersonssplitcreate description: 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-analytic call: posthog-persons.environmentspersonssplitcreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: POST name: environmentspersonssplitcreate description: 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-analytic call: posthog-persons.environmentspersonssplitcreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/environments/{environment-id}/persons/{id}/update-property name: api-environments-environment-id-persons-id-update-property description: REST surface for api-environments-environment_id-persons-id-update_property. operations: - method: POST name: environmentspersonsupdatepropertycreate description: 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-analytic call: posthog-persons.environmentspersonsupdatepropertycreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: POST name: environmentspersonsupdatepropertycreate description: 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-analytic call: posthog-persons.environmentspersonsupdatepropertycreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons name: api-projects-project-id-persons description: REST surface for api-projects-project_id-persons. operations: - method: GET name: personslist description: 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-analytic call: posthog-persons.personslist with: distinct_id: rest.distinct_id email: rest.email format: rest.format limit: rest.limit offset: rest.offset properties: rest.properties search: rest.search outputParameters: - type: object mapping: $. - method: GET name: personslist description: 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-analytic call: posthog-persons.personslist with: distinct_id: rest.distinct_id email: rest.email format: rest.format limit: rest.limit offset: rest.offset properties: rest.properties search: rest.search outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/activity name: api-projects-project-id-persons-activity description: REST surface for api-projects-project_id-persons-activity. operations: - method: GET name: personsallactivityretrieve description: 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-analytic call: posthog-persons.personsallactivityretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: GET name: personsallactivityretrieve description: 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-analytic call: posthog-persons.personsallactivityretrieve with: format: rest.format outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/batch-by-distinct-ids name: api-projects-project-id-persons-batch-by-distinct-ids description: REST surface for api-projects-project_id-persons-batch_by_distinct_ids. operations: - method: POST name: personsbatchbydistinctidscreate description: 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-analytic call: posthog-persons.personsbatchbydistinctidscreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - method: POST name: personsbatchbydistinctidscreate description: 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-analytic call: posthog-persons.personsbatchbydistinctidscreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/batch-by-uuids name: api-projects-project-id-persons-batch-by-uuids description: REST surface for api-projects-project_id-persons-batch_by_uuids. operations: - method: POST name: personsbatchbyuuidscreate description: 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-analytic call: posthog-persons.personsbatchbyuuidscreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - method: POST name: personsbatchbyuuidscreate description: 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-analytic call: posthog-persons.personsbatchbyuuidscreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/bulk-delete name: api-projects-project-id-persons-bulk-delete description: REST surface for api-projects-project_id-persons-bulk_delete. operations: - method: POST name: personsbulkdeletecreate description: This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted. call: posthog-persons.personsbulkdeletecreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - method: POST name: personsbulkdeletecreate description: This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted. call: posthog-persons.personsbulkdeletecreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/cohorts name: api-projects-project-id-persons-cohorts description: REST surface for api-projects-project_id-persons-cohorts. operations: - method: GET name: personscohortsretrieve description: 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-analytic call: posthog-persons.personscohortsretrieve with: format: rest.format person_id: rest.person_id outputParameters: - type: object mapping: $. - method: GET name: personscohortsretrieve description: 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-analytic call: posthog-persons.personscohortsretrieve with: format: rest.format person_id: rest.person_id outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/deletion-status name: api-projects-project-id-persons-deletion-status description: REST surface for api-projects-project_id-persons-deletion_status. operations: - method: GET name: personsdeletionstatuslist description: List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed. call: posthog-persons.personsdeletionstatuslist with: format: rest.format limit: rest.limit offset: rest.offset person_uuid: rest.person_uuid status: rest.status outputParameters: - type: object mapping: $. - method: GET name: personsdeletionstatuslist description: List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed. call: posthog-persons.personsdeletionstatuslist with: format: rest.format limit: rest.limit offset: rest.offset person_uuid: rest.person_uuid status: rest.status outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/funnel name: api-projects-project-id-persons-funnel description: REST surface for api-projects-project_id-persons-funnel. operations: - method: GET name: personsfunnelretrieve description: 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-analytic call: posthog-persons.personsfunnelretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: GET name: personsfunnelretrieve description: 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-analytic call: posthog-persons.personsfunnelretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: POST name: personsfunnelcreate description: 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-analytic call: posthog-persons.personsfunnelcreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - method: POST name: personsfunnelcreate description: 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-analytic call: posthog-persons.personsfunnelcreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/funnel/correlation name: api-projects-project-id-persons-funnel-correlation description: REST surface for api-projects-project_id-persons-funnel-correlation. operations: - method: GET name: personsfunnelcorrelationretrieve description: 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-analytic call: posthog-persons.personsfunnelcorrelationretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: GET name: personsfunnelcorrelationretrieve description: 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-analytic call: posthog-persons.personsfunnelcorrelationretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: POST name: personsfunnelcorrelationcreate description: 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-analytic call: posthog-persons.personsfunnelcorrelationcreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - method: POST name: personsfunnelcorrelationcreate description: 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-analytic call: posthog-persons.personsfunnelcorrelationcreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/lifecycle name: api-projects-project-id-persons-lifecycle description: REST surface for api-projects-project_id-persons-lifecycle. operations: - method: GET name: personslifecycleretrieve description: 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-analytic call: posthog-persons.personslifecycleretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: GET name: personslifecycleretrieve description: 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-analytic call: posthog-persons.personslifecycleretrieve with: format: rest.format outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/properties-at-time name: api-projects-project-id-persons-properties-at-time description: REST surface for api-projects-project_id-persons-properties_at_time. operations: - method: GET name: personspropertiesattimeretrieve description: Get person properties as they existed at a specific point in time. call: posthog-persons.personspropertiesattimeretrieve with: debug: rest.debug distinct_id: rest.distinct_id format: rest.format include_set_once: rest.include_set_once person_id: rest.person_id timestamp: rest.timestamp outputParameters: - type: object mapping: $. - method: GET name: personspropertiesattimeretrieve description: Get person properties as they existed at a specific point in time. call: posthog-persons.personspropertiesattimeretrieve with: debug: rest.debug distinct_id: rest.distinct_id format: rest.format include_set_once: rest.include_set_once person_id: rest.person_id timestamp: rest.timestamp outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/reset-person-distinct-id name: api-projects-project-id-persons-reset-person-distinct-id description: REST surface for api-projects-project_id-persons-reset_person_distinct_id. operations: - method: POST name: personsresetpersondistinctidcreate description: Reset a distinct_id for a deleted person. This allows the distinct_id to be used again. call: posthog-persons.personsresetpersondistinctidcreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - method: POST name: personsresetpersondistinctidcreate description: Reset a distinct_id for a deleted person. This allows the distinct_id to be used again. call: posthog-persons.personsresetpersondistinctidcreate with: format: rest.format body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/trends name: api-projects-project-id-persons-trends description: REST surface for api-projects-project_id-persons-trends. operations: - method: GET name: personstrendsretrieve description: 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-analytic call: posthog-persons.personstrendsretrieve with: format: rest.format outputParameters: - type: object mapping: $. - method: GET name: personstrendsretrieve description: 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-analytic call: posthog-persons.personstrendsretrieve with: format: rest.format outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/values name: api-projects-project-id-persons-values description: REST surface for api-projects-project_id-persons-values. operations: - method: GET name: personsvaluesretrieve description: 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-analytic call: posthog-persons.personsvaluesretrieve with: format: rest.format key: rest.key value: rest.value outputParameters: - type: object mapping: $. - method: GET name: personsvaluesretrieve description: 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-analytic call: posthog-persons.personsvaluesretrieve with: format: rest.format key: rest.key value: rest.value outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/{id} name: api-projects-project-id-persons-id description: REST surface for api-projects-project_id-persons-id. operations: - method: GET name: personsretrieve description: 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-analytic call: posthog-persons.personsretrieve with: format: rest.format id: rest.id outputParameters: - type: object mapping: $. - method: GET name: personsretrieve description: 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-analytic call: posthog-persons.personsretrieve with: format: rest.format id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: personsupdate description: Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. call: posthog-persons.personsupdate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: personsupdate description: Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. call: posthog-persons.personsupdate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: personspartialupdate description: 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-analytic call: posthog-persons.personspartialupdate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PATCH name: personspartialupdate description: 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-analytic call: posthog-persons.personspartialupdate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/{id}/activity name: api-projects-project-id-persons-id-activity description: REST surface for api-projects-project_id-persons-id-activity. operations: - method: GET name: personsactivityretrieve description: 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-analytic call: posthog-persons.personsactivityretrieve with: format: rest.format id: rest.id outputParameters: - type: object mapping: $. - method: GET name: personsactivityretrieve description: 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-analytic call: posthog-persons.personsactivityretrieve with: format: rest.format id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/{id}/delete-property name: api-projects-project-id-persons-id-delete-property description: REST surface for api-projects-project_id-persons-id-delete_property. operations: - method: POST name: personsdeletepropertycreate description: 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-analytic call: posthog-persons.personsdeletepropertycreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: POST name: personsdeletepropertycreate description: 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-analytic call: posthog-persons.personsdeletepropertycreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/{id}/properties-timeline name: api-projects-project-id-persons-id-properties-timeline description: REST surface for api-projects-project_id-persons-id-properties_timeline. operations: - method: GET name: personspropertiestimelineretrieve description: 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-analytic call: posthog-persons.personspropertiestimelineretrieve with: format: rest.format id: rest.id outputParameters: - type: object mapping: $. - method: GET name: personspropertiestimelineretrieve description: 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-analytic call: posthog-persons.personspropertiestimelineretrieve with: format: rest.format id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/{id}/split name: api-projects-project-id-persons-id-split description: REST surface for api-projects-project_id-persons-id-split. operations: - method: POST name: personssplitcreate description: 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-analytic call: posthog-persons.personssplitcreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: POST name: personssplitcreate description: 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-analytic call: posthog-persons.personssplitcreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/projects/{project-id}/persons/{id}/update-property name: api-projects-project-id-persons-id-update-property description: REST surface for api-projects-project_id-persons-id-update_property. operations: - method: POST name: personsupdatepropertycreate description: 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-analytic call: posthog-persons.personsupdatepropertycreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: POST name: personsupdatepropertycreate description: 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-analytic call: posthog-persons.personsupdatepropertycreate with: format: rest.format id: rest.id body: rest.body outputParameters: - type: object mapping: $. - type: mcp namespace: posthog-persons-mcp port: 9090 transport: http description: MCP adapter for PostHog API — persons. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: this-endpoint-is-meant-reading description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonslist with: distinct_id: tools.distinct_id email: tools.email format: tools.format limit: tools.limit offset: tools.offset properties: tools.properties search: tools.search outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-2 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonslist with: distinct_id: tools.distinct_id email: tools.email format: tools.format limit: tools.limit offset: tools.offset properties: tools.properties search: tools.search outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-3 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsallactivityretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-4 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsallactivityretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-5 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsbatchbydistinctidscreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-6 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsbatchbydistinctidscreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-7 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsbatchbyuuidscreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-8 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsbatchbyuuidscreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-allows-you-bulk description: This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted. hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsbulkdeletecreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-allows-you-bulk-2 description: This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted. hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsbulkdeletecreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-9 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonscohortsretrieve with: format: tools.format person_id: tools.person_id outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-10 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonscohortsretrieve with: format: tools.format person_id: tools.person_id outputParameters: - type: object mapping: $. - name: list-status-queued-event-deletions description: List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed. hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsdeletionstatuslist with: format: tools.format limit: tools.limit offset: tools.offset person_uuid: tools.person_uuid status: tools.status outputParameters: - type: object mapping: $. - name: list-status-queued-event-deletions-2 description: List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed. hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsdeletionstatuslist with: format: tools.format limit: tools.limit offset: tools.offset person_uuid: tools.person_uuid status: tools.status outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-11 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsfunnelretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-12 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsfunnelretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-13 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsfunnelcreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-14 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsfunnelcreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-15 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsfunnelcorrelationretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-16 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsfunnelcorrelationretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-17 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsfunnelcorrelationcreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-18 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsfunnelcorrelationcreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-19 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonslifecycleretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-20 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonslifecycleretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: get-person-properties-they-existed description: Get person properties as they existed at a specific point in time. hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonspropertiesattimeretrieve with: debug: tools.debug distinct_id: tools.distinct_id format: tools.format include_set_once: tools.include_set_once person_id: tools.person_id timestamp: tools.timestamp outputParameters: - type: object mapping: $. - name: get-person-properties-they-existed-2 description: Get person properties as they existed at a specific point in time. hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonspropertiesattimeretrieve with: debug: tools.debug distinct_id: tools.distinct_id format: tools.format include_set_once: tools.include_set_once person_id: tools.person_id timestamp: tools.timestamp outputParameters: - type: object mapping: $. - name: reset-distinct-id-deleted-person description: Reset a distinct_id for a deleted person. This allows the distinct_id to be used again. hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsresetpersondistinctidcreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: reset-distinct-id-deleted-person-2 description: Reset a distinct_id for a deleted person. This allows the distinct_id to be used again. hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsresetpersondistinctidcreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-21 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonstrendsretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-22 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonstrendsretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-23 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsvaluesretrieve with: format: tools.format key: tools.key value: tools.value outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-24 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsvaluesretrieve with: format: tools.format key: tools.key value: tools.value outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-25 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsretrieve with: format: tools.format id: tools.id outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-26 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsretrieve with: format: tools.format id: tools.id outputParameters: - type: object mapping: $. - name: only-setting-properties-person-properties description: Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. hints: readOnly: false destructive: false idempotent: true call: posthog-persons.environmentspersonsupdate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: only-setting-properties-person-properties-2 description: Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. hints: readOnly: false destructive: false idempotent: true call: posthog-persons.environmentspersonsupdate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-27 description: 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-analytic hints: readOnly: false destructive: false idempotent: true call: posthog-persons.environmentspersonspartialupdate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-28 description: 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-analytic hints: readOnly: false destructive: false idempotent: true call: posthog-persons.environmentspersonspartialupdate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-29 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsactivityretrieve with: format: tools.format id: tools.id outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-30 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonsactivityretrieve with: format: tools.format id: tools.id outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-31 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsdeletepropertycreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-32 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsdeletepropertycreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-33 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonspropertiestimelineretrieve with: format: tools.format id: tools.id outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-34 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.environmentspersonspropertiestimelineretrieve with: format: tools.format id: tools.id outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-35 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonssplitcreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-36 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonssplitcreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-37 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsupdatepropertycreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-38 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.environmentspersonsupdatepropertycreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-39 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personslist with: distinct_id: tools.distinct_id email: tools.email format: tools.format limit: tools.limit offset: tools.offset properties: tools.properties search: tools.search outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-40 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personslist with: distinct_id: tools.distinct_id email: tools.email format: tools.format limit: tools.limit offset: tools.offset properties: tools.properties search: tools.search outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-41 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsallactivityretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-42 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsallactivityretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-43 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsbatchbydistinctidscreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-44 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsbatchbydistinctidscreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-45 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsbatchbyuuidscreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-46 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsbatchbyuuidscreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-allows-you-bulk-3 description: This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted. hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsbulkdeletecreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-allows-you-bulk-4 description: This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted. hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsbulkdeletecreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-47 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personscohortsretrieve with: format: tools.format person_id: tools.person_id outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-48 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personscohortsretrieve with: format: tools.format person_id: tools.person_id outputParameters: - type: object mapping: $. - name: list-status-queued-event-deletions-3 description: List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed. hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsdeletionstatuslist with: format: tools.format limit: tools.limit offset: tools.offset person_uuid: tools.person_uuid status: tools.status outputParameters: - type: object mapping: $. - name: list-status-queued-event-deletions-4 description: List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed. hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsdeletionstatuslist with: format: tools.format limit: tools.limit offset: tools.offset person_uuid: tools.person_uuid status: tools.status outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-49 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsfunnelretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-50 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsfunnelretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-51 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsfunnelcreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-52 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsfunnelcreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-53 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsfunnelcorrelationretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-54 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsfunnelcorrelationretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-55 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsfunnelcorrelationcreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-56 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsfunnelcorrelationcreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-57 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personslifecycleretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-58 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personslifecycleretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: get-person-properties-they-existed-3 description: Get person properties as they existed at a specific point in time. hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personspropertiesattimeretrieve with: debug: tools.debug distinct_id: tools.distinct_id format: tools.format include_set_once: tools.include_set_once person_id: tools.person_id timestamp: tools.timestamp outputParameters: - type: object mapping: $. - name: get-person-properties-they-existed-4 description: Get person properties as they existed at a specific point in time. hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personspropertiesattimeretrieve with: debug: tools.debug distinct_id: tools.distinct_id format: tools.format include_set_once: tools.include_set_once person_id: tools.person_id timestamp: tools.timestamp outputParameters: - type: object mapping: $. - name: reset-distinct-id-deleted-person-3 description: Reset a distinct_id for a deleted person. This allows the distinct_id to be used again. hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsresetpersondistinctidcreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: reset-distinct-id-deleted-person-4 description: Reset a distinct_id for a deleted person. This allows the distinct_id to be used again. hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsresetpersondistinctidcreate with: format: tools.format body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-59 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personstrendsretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-60 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personstrendsretrieve with: format: tools.format outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-61 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsvaluesretrieve with: format: tools.format key: tools.key value: tools.value outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-62 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsvaluesretrieve with: format: tools.format key: tools.key value: tools.value outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-63 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsretrieve with: format: tools.format id: tools.id outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-64 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsretrieve with: format: tools.format id: tools.id outputParameters: - type: object mapping: $. - name: only-setting-properties-person-properties-3 description: Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. hints: readOnly: false destructive: false idempotent: true call: posthog-persons.personsupdate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: only-setting-properties-person-properties-4 description: Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. hints: readOnly: false destructive: false idempotent: true call: posthog-persons.personsupdate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-65 description: 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-analytic hints: readOnly: false destructive: false idempotent: true call: posthog-persons.personspartialupdate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-66 description: 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-analytic hints: readOnly: false destructive: false idempotent: true call: posthog-persons.personspartialupdate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-67 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsactivityretrieve with: format: tools.format id: tools.id outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-68 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personsactivityretrieve with: format: tools.format id: tools.id outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-69 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsdeletepropertycreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-70 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsdeletepropertycreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-71 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personspropertiestimelineretrieve with: format: tools.format id: tools.id outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-72 description: 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-analytic hints: readOnly: true destructive: false idempotent: true call: posthog-persons.personspropertiestimelineretrieve with: format: tools.format id: tools.id outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-73 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personssplitcreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-74 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personssplitcreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-75 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsupdatepropertycreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: this-endpoint-is-meant-reading-76 description: 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-analytic hints: readOnly: false destructive: false idempotent: false call: posthog-persons.personsupdatepropertycreate with: format: tools.format id: tools.id body: tools.body outputParameters: - type: object mapping: $.