PostHog

Delete organization via DELETE /api/organizations/{id}/

Delete organization domain via DELETE /api/organizations/{organization_id}/domains/{id}/

Delete organization invite via DELETE /api/organizations/{organization_id}/invites/{id}/

Delete organization member via DELETE /api/organizations/{organization_id}/members/{user__uuid}/

Delete project via DELETE /api/organizations/{organization_id}/projects/{id}/ Projects for the current organization.

Delete role via DELETE /api/organizations/{organization_id}/roles/{id}/ Role endpoints disclose member records, so they scope them the same way the members list does when the org restricts member list visibility.

Delete role membership via DELETE /api/organizations/{organization_id}/roles/{role_id}/role_memberships/{id}/ Role endpoints disclose member records, so they scope them the same way the members list does when the org restricts member list visibility.

Delete action via DELETE /api/projects/{project_id}/actions/{id}/ Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Delete alert via DELETE /api/projects/{project_id}/alerts/{id}/

Delete annotation via DELETE /api/projects/{project_id}/annotations/{id}/ Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Delete cohort via DELETE /api/projects/{project_id}/cohorts/{id}/ Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Delete comment via DELETE /api/projects/{project_id}/comments/{id}/ Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Delete dashboard template via DELETE /api/projects/{project_id}/dashboard_templates/{id}/ Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Delete dashboard collaborator via DELETE /api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/{user__uuid}/

Delete dashboard sharing password via DELETE /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/passwords/{password_id}/ Delete a password from the sharing configuration.

Delete dashboard via DELETE /api/projects/{project_id}/dashboards/{id}/ Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Delete early access feature via DELETE /api/projects/{project_id}/early_access_feature/{id}/

Delete event definition via DELETE /api/projects/{project_id}/event_definitions/{id}/

Delete experiment holdout via DELETE /api/projects/{project_id}/experiment_holdouts/{id}/

Delete experiment saved metric via DELETE /api/projects/{project_id}/experiment_saved_metrics/{id}/

Delete experiment via DELETE /api/projects/{project_id}/experiments/{id}/ Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Delete feature flag via DELETE /api/projects/{project_id}/feature_flags/{id}/ Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Delete group type via DELETE /api/projects/{project_id}/groups_types/{group_type_index}/

Delete group type metric via DELETE /api/projects/{project_id}/groups_types/{group_type_index}/metrics/{id}/

Delete insight variable via DELETE /api/projects/{project_id}/insight_variables/{id}/

Delete insight via DELETE /api/projects/{project_id}/insights/{id}/ Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Delete insight sharing password via DELETE /api/projects/{project_id}/insights/{insight_id}/sharing/passwords/{password_id}/ Delete a password from the sharing configuration.

Delete property definition via DELETE /api/projects/{project_id}/property_definitions/{id}/

Delete query via DELETE /api/projects/{project_id}/query/{id}/ (Experimental)

Delete session recording playlist recording via DELETE /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/

Delete session recording via DELETE /api/projects/{project_id}/session_recordings/{id}/

Delete session recording sharing password via DELETE /api/projects/{project_id}/session_recordings/{recording_id}/sharing/passwords/{password_id}/ Delete a password from the sharing configuration.

Delete subscription via DELETE /api/projects/{project_id}/subscriptions/{id}/ Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Delete survey via DELETE /api/projects/{project_id}/surveys/{id}/

List organizations via GET /api/organizations/

Get organization via GET /api/organizations/{id}/

List organization domains via GET /api/organizations/{organization_id}/domains/

Get organization domain via GET /api/organizations/{organization_id}/domains/{id}/

List organization invites via GET /api/organizations/{organization_id}/invites/

List organization members via GET /api/organizations/{organization_id}/members/

List projects via GET /api/organizations/{organization_id}/projects/ Projects for the current organization.

Get project via GET /api/organizations/{organization_id}/projects/{id}/ Retrieve a project and its settings.

Get project event ingestion restrictions via GET /api/organizations/{organization_id}/projects/{id}/event_ingestion_restrictions/ Projects for the current organization.

List roles via GET /api/organizations/{organization_id}/roles/ Role endpoints disclose member records, so they scope them the same way the members list does when the org restricts member list visibility.

Get role via GET /api/organizations/{organization_id}/roles/{id}/ Role endpoints disclose member records, so they scope them the same way the members list does when the org restricts member list visibility.

Get role memberships via GET /api/organizations/{organization_id}/roles/{role_id}/role_memberships/ Role endpoints disclose member records, so they scope them the same way the members list does when the org restricts member list visibility.

Get role membership via GET /api/organizations/{organization_id}/roles/{role_id}/role_memberships/{id}/ Role endpoints disclose member records, so they scope them the same way the members list does when the org restricts member list visibility.

List actions via GET /api/projects/{project_id}/actions/

Get action via GET /api/projects/{project_id}/actions/{id}/

Get action references via GET /api/projects/{project_id}/actions/{id}/references/

List activity log via GET /api/projects/{project_id}/activity_log/

List alerts via GET /api/projects/{project_id}/alerts/

Get alert via GET /api/projects/{project_id}/alerts/{id}/

List annotations via GET /api/projects/{project_id}/annotations/ Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.

Get annotation via GET /api/projects/{project_id}/annotations/{id}/ Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.

List cohorts via GET /api/projects/{project_id}/cohorts/

Get cohorts activity via GET /api/projects/{project_id}/cohorts/activity/

Get cohort via GET /api/projects/{project_id}/cohorts/{id}/

Get cohort activity via GET /api/projects/{project_id}/cohorts/{id}/activity/

Get cohort calculation history via GET /api/projects/{project_id}/cohorts/{id}/calculation_history/

Get cohort persons via GET /api/projects/{project_id}/cohorts/{id}/persons/

Get cohort used in via GET /api/projects/{project_id}/cohorts/{id}/used_in/

List comments via GET /api/projects/{project_id}/comments/

Get comment via GET /api/projects/{project_id}/comments/{id}/

Get comment thread via GET /api/projects/{project_id}/comments/{id}/thread/

Get comments count via GET /api/projects/{project_id}/comments/count/

List dashboard templates via GET /api/projects/{project_id}/dashboard_templates/

Get dashboard template via GET /api/projects/{project_id}/dashboard_templates/{id}/

List dashboards via GET /api/projects/{project_id}/dashboards/

Get dashboard collaborators via GET /api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/

Get dashboard sharing via GET /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/

Get dashboard via GET /api/projects/{project_id}/dashboards/{id}/

List early access features via GET /api/projects/{project_id}/early_access_feature/

Get early access feature via GET /api/projects/{project_id}/early_access_feature/{id}/

List elements via GET /api/projects/{project_id}/elements/

Get elements stats via GET /api/projects/{project_id}/elements/stats/ Counts of $autocapture, $rageclick, and $dead_click events grouped by the element chain they occurred on, ordered by count. Defaults to all three event types; narrow with the include parameter.

Get elements values via GET /api/projects/{project_id}/elements/values/

List event definitions via GET /api/projects/{project_id}/event_definitions/

Get event definition via GET /api/projects/{project_id}/event_definitions/{id}/

Get event definitions by name via GET /api/projects/{project_id}/event_definitions/by_name/ Get event definition by exact name

Get event definitions primary properties via GET /api/projects/{project_id}/event_definitions/primary_properties/ Resolve team-configured primary properties for event definitions. The response only contains entries where a non-null primary_property is set on the EventDefinition. Callers should fall back to the core taxonomy defaults client-side for...

List events via GET /api/projects/{project_id}/events/ This endpoint allows you to list and filter events. It is effectively deprecated and is kept only for backwards compatibility. If you ever ask about it you will be advised to not use it... If you want to ad-hoc list or aggregate events...

Get event via GET /api/projects/{project_id}/events/{id}/

Get events values via GET /api/projects/{project_id}/events/values/

List experiment holdouts via GET /api/projects/{project_id}/experiment_holdouts/

Get experiment holdout via GET /api/projects/{project_id}/experiment_holdouts/{id}/

List experiment saved metrics via GET /api/projects/{project_id}/experiment_saved_metrics/

Get experiment saved metric via GET /api/projects/{project_id}/experiment_saved_metrics/{id}/

List experiments via GET /api/projects/{project_id}/experiments/ List experiments for the current project. Supports filtering by status and archival state.

Get experiment via GET /api/projects/{project_id}/experiments/{id}/ Retrieve a single experiment by ID, including its current status, metrics, feature flag, and results metadata.

Get experiment activity via GET /api/projects/{project_id}/experiments/{id}/activity/ Change history for this experiment. Returns a paginated audit trail of changes to the experiment, its holdouts and shared metrics, and its linked feature flag: who made each change, what changed (field-level before/after values), and when....

List exports via GET /api/projects/{project_id}/exports/

Get export via GET /api/projects/{project_id}/exports/{id}/

List feature flags via GET /api/projects/{project_id}/feature_flags/ Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library...

Get feature flags activity via GET /api/projects/{project_id}/feature_flags/activity/ Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library...

Get feature flag via GET /api/projects/{project_id}/feature_flags/{id}/ Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library...

Get feature flag activity via GET /api/projects/{project_id}/feature_flags/{id}/activity/ Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library...

Get feature flag dependent flags via GET /api/projects/{project_id}/feature_flags/{id}/dependent_flags/ Get other active flags that depend on this flag.

Get feature flag remote config via GET /api/projects/{project_id}/feature_flags/{id}/remote_config/ Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library...

Get feature flag status via GET /api/projects/{project_id}/feature_flags/{id}/status/ Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library...

Get feature flag version via GET /api/projects/{project_id}/feature_flags/{id}/versions/{version_number}/ Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library...

Get feature flags evaluation reasons via GET /api/projects/{project_id}/feature_flags/evaluation_reasons/ Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library...

Get feature flags my flags via GET /api/projects/{project_id}/feature_flags/my_flags/ Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library...

List groups via GET /api/projects/{project_id}/groups/ List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/. Uses forward-only keyset pagination via the `cursor` parameter. The `previous`...

Get groups activity via GET /api/projects/{project_id}/groups/activity/

Find groups via GET /api/projects/{project_id}/groups/find/

Get groups property values via GET /api/projects/{project_id}/groups/property_values/

Get groups related via GET /api/projects/{project_id}/groups/related/

List group types via GET /api/projects/{project_id}/groups_types/

Get group type metrics via GET /api/projects/{project_id}/groups_types/{group_type_index}/metrics/

Get group type metric via GET /api/projects/{project_id}/groups_types/{group_type_index}/metrics/{id}/

List heatmaps via GET /api/projects/{project_id}/heatmaps/ Aggregated heatmap interactions for a page. For type 'click'/'rageclick'/'mousemove' each result is a point with relative x, absolute client-y, and a count. For type 'scrolldepth' the response is scroll-depth buckets instead (cumulative...

Get heatmaps events via GET /api/projects/{project_id}/heatmaps/events/ Drill into the individual session interactions behind one or more heatmap coordinates. Pass the 'points' you want to inspect (from the heatmaps list response) to get the underlying per-session events, so you can jump to the session...

List insight variables via GET /api/projects/{project_id}/insight_variables/

Get insight variable via GET /api/projects/{project_id}/insight_variables/{id}/

List insights via GET /api/projects/{project_id}/insights/ DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth +...

Get insights activity via GET /api/projects/{project_id}/insights/activity/ Project-wide audit trail across all insights — who created, edited, deleted, or restored insights, what changed (with before/after diffs), and when. Useful for surfacing what people (or agents) have been working on recently.

Get insight via GET /api/projects/{project_id}/insights/{id}/ DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth +...

Get insight activity via GET /api/projects/{project_id}/insights/{id}/activity/ Audit trail for a single insight — every change made to it, by whom, and when. Use this when you want the change history of a specific insight; use the project-wide activity endpoint for a broader view.

Get insight sharing via GET /api/projects/{project_id}/insights/{insight_id}/sharing/

Get insight thresholds via GET /api/projects/{project_id}/insights/{insight_id}/thresholds/

Get insight threshold via GET /api/projects/{project_id}/insights/{insight_id}/thresholds/{id}/

List persons via GET /api/projects/{project_id}/persons/ 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`...

Get persons activity via GET /api/projects/{project_id}/persons/activity/ 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`...

Get person via GET /api/projects/{project_id}/persons/{id}/ 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`...

Get person activity via GET /api/projects/{project_id}/persons/{id}/activity/ 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`...

Get persons cohorts via GET /api/projects/{project_id}/persons/cohorts/ 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`...

Get persons deletion status via GET /api/projects/{project_id}/persons/deletion_status/ 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 persons properties at time via GET /api/projects/{project_id}/persons/properties_at_time/ Get person properties as they existed at a specific point in time. This endpoint reconstructs person properties by querying ClickHouse events for $set and $set_once operations up to the specified timestamp. Query parameters: - distinct_id...

Get persons values via GET /api/projects/{project_id}/persons/values/ 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`...

List property definitions via GET /api/projects/{project_id}/property_definitions/

Get property definition via GET /api/projects/{project_id}/property_definitions/{id}/

Get property definitions seen together via GET /api/projects/{project_id}/property_definitions/seen_together/ Allows a caller to provide a list of event names and a single property name Returns a map of the event names to a boolean representing whether that property has ever been seen with that event_name

Get query via GET /api/projects/{project_id}/query/{id}/ (Experimental)

List session recording playlists via GET /api/projects/{project_id}/session_recording_playlists/ Override list to include synthetic playlists. Synthetics have no DB row, so we compute each one's position in the merged sort and split the requested page between synthetics and a DB queryset slice. The merge/rank/sort is all in-memory, so...

Get session recording playlist via GET /api/projects/{project_id}/session_recording_playlists/{short_id}/

Get session recording playlist recordings via GET /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/

List session recordings via GET /api/projects/{project_id}/session_recordings/

Get session recording via GET /api/projects/{project_id}/session_recordings/{id}/

Get session recording sharing via GET /api/projects/{project_id}/session_recordings/{recording_id}/sharing/

Get sessions property definitions via GET /api/projects/{project_id}/sessions/property_definitions/

Get sessions values via GET /api/projects/{project_id}/sessions/values/

List subscriptions via GET /api/projects/{project_id}/subscriptions/

Get subscription via GET /api/projects/{project_id}/subscriptions/{id}/

Get subscriptions summary quota via GET /api/projects/{project_id}/subscriptions/summary_quota/

List surveys via GET /api/projects/{project_id}/surveys/

Get surveys activity via GET /api/projects/{project_id}/surveys/activity/

Get survey via GET /api/projects/{project_id}/surveys/{id}/

Get survey activity via GET /api/projects/{project_id}/surveys/{id}/activity/

Get survey responses via GET /api/projects/{project_id}/surveys/{id}/responses/ List survey responses for a specific survey, with question text resolved server-side so callers do not have to map opaque `$survey_response_<id>` keys. Each row carries `distinct_id`, `session_id`, `submitted_at`, and an `extra` block...

Get survey stats via GET /api/projects/{project_id}/surveys/{id}/stats/ Get survey response statistics for a specific survey. Args: date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z) date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z) exclude_archived: Optional...

Get surveys responses count via GET /api/projects/{project_id}/surveys/responses_count/ Get response counts for all surveys. Args: exclude_archived: Optional boolean to exclude archived responses (default: false, includes archived) survey_ids: Optional comma-separated list of survey IDs to filter by Returns: Dictionary...

Get surveys stats via GET /api/projects/{project_id}/surveys/stats/ Get aggregated response statistics across all surveys. Args: date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z) date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z) Returns: Aggregated...

List users via GET /api/users/

Get user via GET /api/users/{uuid}/ Retrieve a user's profile and settings. Pass `@me` as the UUID to fetch the authenticated user; non-staff callers may only access their own account.

Update organization via PATCH /api/organizations/{id}/

Update organization domain via PATCH /api/organizations/{organization_id}/domains/{id}/

Update organization member via PATCH /api/organizations/{organization_id}/members/{user__uuid}/

Update project via PATCH /api/organizations/{organization_id}/projects/{id}/ Update one or more of a project's settings. Only the fields included in the request body are changed.

Add product intent project via PATCH /api/organizations/{organization_id}/projects/{id}/add_product_intent/ Projects for the current organization.

Complete product onboarding project via PATCH /api/organizations/{organization_id}/projects/{id}/complete_product_onboarding/ Projects for the current organization.

Update role via PATCH /api/organizations/{organization_id}/roles/{id}/ Role endpoints disclose member records, so they scope them the same way the members list does when the org restricts member list visibility.

Update action via PATCH /api/projects/{project_id}/actions/{id}/

Update alert via PATCH /api/projects/{project_id}/alerts/{id}/

Update annotation via PATCH /api/projects/{project_id}/annotations/{id}/ Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.

Update cohort via PATCH /api/projects/{project_id}/cohorts/{id}/

Add persons to static cohort via PATCH /api/projects/{project_id}/cohorts/{id}/add_persons_to_static_cohort/

Remove person from static cohort via PATCH /api/projects/{project_id}/cohorts/{id}/remove_person_from_static_cohort/

Update comment via PATCH /api/projects/{project_id}/comments/{id}/

Update dashboard template via PATCH /api/projects/{project_id}/dashboard_templates/{id}/

Update dashboard via PATCH /api/projects/{project_id}/dashboards/{id}/

Move tile dashboard via PATCH /api/projects/{project_id}/dashboards/{id}/move_tile/

Update early access feature via PATCH /api/projects/{project_id}/early_access_feature/{id}/

Update event definition via PATCH /api/projects/{project_id}/event_definitions/{id}/

Update experiment holdout via PATCH /api/projects/{project_id}/experiment_holdouts/{id}/

Update experiment saved metric via PATCH /api/projects/{project_id}/experiment_saved_metrics/{id}/

Update experiment via PATCH /api/projects/{project_id}/experiments/{id}/ Update an experiment. Use this to modify experiment properties such as name, description, metrics, variants, and configuration. Metrics can be added, changed and removed at any time. Feature-flag config (variants, rollout, payloads) is...

Update feature flag via PATCH /api/projects/{project_id}/feature_flags/{id}/ Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library...

Update group type metric via PATCH /api/projects/{project_id}/groups_types/{group_type_index}/metrics/{id}/

Update insight variable via PATCH /api/projects/{project_id}/insight_variables/{id}/

Update insight via PATCH /api/projects/{project_id}/insights/{id}/ DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth +...

Update person via PATCH /api/projects/{project_id}/persons/{id}/ 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`...

Update property definition via PATCH /api/projects/{project_id}/property_definitions/{id}/

Update session recording playlist via PATCH /api/projects/{project_id}/session_recording_playlists/{short_id}/

Update session recording via PATCH /api/projects/{project_id}/session_recordings/{id}/

Update subscription via PATCH /api/projects/{project_id}/subscriptions/{id}/

Update survey via PATCH /api/projects/{project_id}/surveys/{id}/

Update user via PATCH /api/users/{uuid}/ Update one or more of the authenticated user's profile fields or settings.

Create organization via POST /api/organizations/

Create organization domain via POST /api/organizations/{organization_id}/domains/

Create organization invite via POST /api/organizations/{organization_id}/invites/

Bulk organization invites via POST /api/organizations/{organization_id}/invites/bulk/

Create project via POST /api/organizations/{organization_id}/projects/ Projects for the current organization.

Create role via POST /api/organizations/{organization_id}/roles/ Role endpoints disclose member records, so they scope them the same way the members list does when the org restricts member list visibility.

Create role memberships via POST /api/organizations/{organization_id}/roles/{role_id}/role_memberships/ Role endpoints disclose member records, so they scope them the same way the members list does when the org restricts member list visibility.

Create action via POST /api/projects/{project_id}/actions/

Create alert via POST /api/projects/{project_id}/alerts/

Test delivery alert via POST /api/projects/{project_id}/alerts/{id}/test-delivery/ Send a synthetic test notification to subscribed users and every active destination on this alert.

Simulate alerts via POST /api/projects/{project_id}/alerts/simulate/ Simulate a detector on an insight's historical data. Read-only — no AlertCheck records are created.

Create annotation via POST /api/projects/{project_id}/annotations/ Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.

Create cohort via POST /api/projects/{project_id}/cohorts/

Create comment via POST /api/projects/{project_id}/comments/ Create a comment. Support messages are deduplicated: an identical message from the same author on the same ticket within a short window returns the original comment with a 200 instead of creating a second one, and a 409 while a concurrent...

Create dashboard template via POST /api/projects/{project_id}/dashboard_templates/

Create dashboard via POST /api/projects/{project_id}/dashboards/

Create dashboard collaborators via POST /api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/

Create dashboard sharing passwords via POST /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/passwords/ Create a new password for the sharing configuration.

Create dashboard sharing refresh via POST /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/refresh/

Create text tile dashboard via POST /api/projects/{project_id}/dashboards/{id}/create_text_tile/ Add a markdown text tile to a dashboard. Text tiles render as markdown blocks on the dashboard — useful as section headings, dividers, or annotations between insight tiles to give the dashboard structure.

Delete tile dashboard via POST /api/projects/{project_id}/dashboards/{id}/delete_tile/ Soft-delete a single tile from a dashboard. Works for text, insight, and button tiles. The underlying Insight, Text, or ButtonTile object is preserved — only the dashboard tile is hidden. To delete the entire dashboard, use the dashboard...

Reorder tiles dashboard via POST /api/projects/{project_id}/dashboards/{id}/reorder_tiles/

Update text tile dashboard via POST /api/projects/{project_id}/dashboards/{id}/update_text_tile/ Update the markdown body, layout, or color of an existing text tile on a dashboard.

Create early access feature via POST /api/projects/{project_id}/early_access_feature/

Create event definition via POST /api/projects/{project_id}/event_definitions/

Bulk update tags event definitions via POST /api/projects/{project_id}/event_definitions/bulk_update_tags/ Add, remove, or replace tags across multiple event definitions in one request. Overrides ``TaggedItemViewSetMixin.bulk_update_tags``, which assumes integer PKs and runs object-level access-control filtering. Event definitions use UUID PKs...

Bulk update verified event definitions via POST /api/projects/{project_id}/event_definitions/bulk_update_verified/ Mark multiple event definitions as verified or unverified in one request. In the same vein as ``bulk_update_tags``, but ``verified`` lives on the enterprise ``EnterpriseEventDefinition`` extension rather than the base row, so this action...

Create experiment holdout via POST /api/projects/{project_id}/experiment_holdouts/

Create experiment saved metric via POST /api/projects/{project_id}/experiment_saved_metrics/

Create experiment via POST /api/projects/{project_id}/experiments/ Create a new experiment in draft status with optional metrics.

Archive experiment via POST /api/projects/{project_id}/experiments/{id}/archive/ Archive an ended experiment. Hides the experiment from the default list view. The experiment can be restored at any time by updating archived=false. When the linked feature flag is still enabled, pass disable_feature_flag=true to also...

Copy to project experiment via POST /api/projects/{project_id}/experiments/{id}/copy_to_project/ Copy an experiment into another project in the same organization as a new draft.

Duplicate experiment via POST /api/projects/{project_id}/experiments/{id}/duplicate/ Mixin for ViewSets to handle approval-gate exceptions raised from decorated serializers. Intercepts ApprovalRequired (409) and PolicyConflict (400) raised by the @approval_gate decorator on serializer methods and converts them into the...

End experiment via POST /api/projects/{project_id}/experiments/{id}/end/ End a running experiment without shipping a variant. Sets end_date to now and marks the experiment as stopped. The feature flag is NOT modified — users continue to see their assigned variants and exposure events ($feature_flag_called)...

Launch experiment via POST /api/projects/{project_id}/experiments/{id}/launch/ Launch a draft experiment. Validates the experiment is in draft state, activates its linked feature flag, sets start_date to the current server time, and transitions the experiment to running. Returns 400 if the experiment has already been...

Pause experiment via POST /api/projects/{project_id}/experiments/{id}/pause/ Pause a running experiment. Deactivates the linked feature flag so it is no longer returned by the /decide endpoint. Users fall back to the application default (typically the control experience), and no new exposure events are recorded...

Reset experiment via POST /api/projects/{project_id}/experiments/{id}/reset/ Reset an experiment back to draft state. Clears start/end dates, conclusion, archived flag, and any flag-cleanup task pointer. The feature flag is left unchanged — users continue to see their assigned variants. Previously collected events...

Resume experiment via POST /api/projects/{project_id}/experiments/{id}/resume/ Resume a paused experiment. Reactivates the linked feature flag so it is returned by /decide again. Users are re-bucketed deterministically into the same variants they had before the pause, and exposure tracking resumes. Returns 400 if the...

Ship variant experiment via POST /api/projects/{project_id}/experiments/{id}/ship_variant/ Ship a variant and (optionally) end the experiment. Updates the feature flag so the selected variant gets 100% of the variant distribution. By default, existing release conditions on the flag are preserved untouched — the variant is served...

Unarchive experiment via POST /api/projects/{project_id}/experiments/{id}/unarchive/ Unarchive an archived experiment. Restores the experiment to the default list view. Returns 400 if the experiment is not currently archived.

Create export via POST /api/projects/{project_id}/exports/

Create feature flag via POST /api/projects/{project_id}/feature_flags/ Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library...

Bulk delete feature flags via POST /api/projects/{project_id}/feature_flags/bulk_delete/ Bulk delete feature flags by filter criteria or explicit IDs. Accepts either: - {"filters": {...}} - Same filter params as list endpoint (search, active, type, etc.) - {"ids": [...]} - Explicit list of flag IDs (no limit) Returns same...

Bulk update tags feature flags via POST /api/projects/{project_id}/feature_flags/bulk_update_tags/ Bulk update tags on multiple objects. PAT access: this action has no ``required_scopes=`` on the decorator — inheriting viewsets must add ``"bulk_update_tags"`` to their ``scope_object_write_actions`` list to accept personal API keys....

Test evaluation feature flag via POST /api/projects/{project_id}/feature_flags/{id}/test_evaluation/ Test feature flag evaluation against a specific user at an optional point in time. This endpoint allows testing how a feature flag would evaluate for a specific user, optionally at a historical timestamp. When a timestamp is provided, both...

Create feature flags user blast radius via POST /api/projects/{project_id}/feature_flags/user_blast_radius/ Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library...

Create group via POST /api/projects/{project_id}/groups/

Delete property groups via POST /api/projects/{project_id}/groups/delete_property/

Create group type metrics via POST /api/projects/{project_id}/groups_types/{group_type_index}/metrics/

Update property groups via POST /api/projects/{project_id}/groups/update_property/

Create insight variable via POST /api/projects/{project_id}/insight_variables/

Create insight via POST /api/projects/{project_id}/insights/ DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth +...

Bulk delete insights via POST /api/projects/{project_id}/insights/bulk_delete/ Soft-delete insights in bulk by ID. Mirrors the single-insight delete: sets deleted=True, soft-deletes the insights' dashboard tiles, and removes their linked alerts. Insights the requester cannot edit are skipped and reported in...

Bulk restore insights via POST /api/projects/{project_id}/insights/bulk_restore/ Restore soft-deleted insights in bulk by ID — the inverse of bulk_delete. Sets deleted=False and re-activates the insights' dashboard tiles on dashboards that still exist. Linked alerts are not restored (they are removed on delete)....

Create insight sharing passwords via POST /api/projects/{project_id}/insights/{insight_id}/sharing/passwords/ Create a new password for the sharing configuration.

Create insight sharing refresh via POST /api/projects/{project_id}/insights/{insight_id}/sharing/refresh/

Viewed insights via POST /api/projects/{project_id}/insights/viewed/ Record that the current user has just viewed one or more insights. Submitted ids that do not belong to the current project or that point at deleted insights are silently dropped, as are views from impersonated staff-support sessions....

Create persons batch by distinct ids via POST /api/projects/{project_id}/persons/batch_by_distinct_ids/ 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`...

Create persons batch by uuids via POST /api/projects/{project_id}/persons/batch_by_uuids/ 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`...

Bulk delete persons via POST /api/projects/{project_id}/persons/bulk_delete/ 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.

Delete property person via POST /api/projects/{project_id}/persons/{id}/delete_property/ 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`...

Split person via POST /api/projects/{project_id}/persons/{id}/split/ Split distinct_ids off a merged person. Two mutually exclusive modes: - **`distinct_ids_to_split`** (recommended for surgical edits): moves only the listed distinct_ids off this person onto new single-id persons. The original person keeps...

Update property person via POST /api/projects/{project_id}/persons/{id}/update_property/ 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`...

Reset person distinct id via POST /api/projects/{project_id}/persons/reset_person_distinct_id/ Reset a distinct_id for a deleted person. This allows the distinct_id to be used again.

Create query via POST /api/projects/{project_id}/query/ DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth +...

Create session recording playlist via POST /api/projects/{project_id}/session_recording_playlists/

Create session recording playlist recording via POST /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/

Create session recording sharing passwords via POST /api/projects/{project_id}/session_recordings/{recording_id}/sharing/passwords/ Create a new password for the sharing configuration.

Create session recording sharing refresh via POST /api/projects/{project_id}/session_recordings/{recording_id}/sharing/refresh/

Create subscription via POST /api/projects/{project_id}/subscriptions/

Test delivery subscription via POST /api/projects/{project_id}/subscriptions/{id}/test-delivery/

Create survey via POST /api/projects/{project_id}/surveys/

Launch survey via POST /api/projects/{project_id}/surveys/{id}/launch/ Launch a survey by setting `start_date` to the current time. No-op if the survey is already launched (start_date set in the past) — returns the existing state unchanged. Does not affect archived surveys or surveys with an end_date in the...

Create survey responses archive via POST /api/projects/{project_id}/surveys/{id}/responses/{response_uuid}/archive/ Archive a single survey response.

Create survey responses unarchive via POST /api/projects/{project_id}/surveys/{id}/responses/{response_uuid}/unarchive/ Unarchive a single survey response.

Stop survey via POST /api/projects/{project_id}/surveys/{id}/stop/ Stop a survey by setting `end_date` to the current time. No new responses are accepted after this; existing responses remain available. No-op if the survey already has an end_date in the past.

Replace organization via PUT /api/organizations/{id}/

Replace organization domain via PUT /api/organizations/{organization_id}/domains/{id}/

Replace organization member via PUT /api/organizations/{organization_id}/members/{user__uuid}/

Replace project via PUT /api/organizations/{organization_id}/projects/{id}/ Replace a project and its settings. Prefer the PATCH endpoint for partial updates — PUT requires every writable field to be provided.

Replace role via PUT /api/organizations/{organization_id}/roles/{id}/ Role endpoints disclose member records, so they scope them the same way the members list does when the org restricts member list visibility.

Replace action via PUT /api/projects/{project_id}/actions/{id}/

Replace alert via PUT /api/projects/{project_id}/alerts/{id}/

Replace annotation via PUT /api/projects/{project_id}/annotations/{id}/ Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.

Replace cohort via PUT /api/projects/{project_id}/cohorts/{id}/

Replace comment via PUT /api/projects/{project_id}/comments/{id}/

Replace dashboard template via PUT /api/projects/{project_id}/dashboard_templates/{id}/

Replace dashboard via PUT /api/projects/{project_id}/dashboards/{id}/

Replace early access feature via PUT /api/projects/{project_id}/early_access_feature/{id}/

Replace event definition via PUT /api/projects/{project_id}/event_definitions/{id}/

Replace experiment holdout via PUT /api/projects/{project_id}/experiment_holdouts/{id}/

Replace experiment saved metric via PUT /api/projects/{project_id}/experiment_saved_metrics/{id}/

Replace experiment via PUT /api/projects/{project_id}/experiments/{id}/ Mixin for ViewSets to handle approval-gate exceptions raised from decorated serializers. Intercepts ApprovalRequired (409) and PolicyConflict (400) raised by the @approval_gate decorator on serializer methods and converts them into the...

Replace feature flag via PUT /api/projects/{project_id}/feature_flags/{id}/ Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library...

Replace group type metric via PUT /api/projects/{project_id}/groups_types/{group_type_index}/metrics/{id}/

Replace insight variable via PUT /api/projects/{project_id}/insight_variables/{id}/

Replace insight via PUT /api/projects/{project_id}/insights/{id}/ DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth +...

Replace person via PUT /api/projects/{project_id}/persons/{id}/ Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. This means that only the properties listed will be updated, but other properties won't be removed nor updated. If you would...

Replace property definition via PUT /api/projects/{project_id}/property_definitions/{id}/

Replace session recording playlist via PUT /api/projects/{project_id}/session_recording_playlists/{short_id}/

Replace session recording via PUT /api/projects/{project_id}/session_recordings/{id}/

Replace subscription via PUT /api/projects/{project_id}/subscriptions/{id}/

Replace survey via PUT /api/projects/{project_id}/surveys/{id}/