persons

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.

get/api/projects/{project_id}/persons/deletion_status/

Request

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

Path parameters

project_idstring required

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

Query parameters

format'csv' | 'json'
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

person_uuidstring uuid

Filter by a specific person UUID.

status'all' | 'completed' | 'pending'

Filter by deletion status: 'pending', 'completed', or 'all'.

Response

nextstring uri nullable
previousstring uri nullable
countinteger

Example response

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

Changes

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