Core-13
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
POST | |
DELETE | |
POST | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
POST | |
GET | |
GET | |
GET | |
PATCH | |
DELETE | |
POST | |
GET | |
GET | |
PATCH |
Create session recordings sharing passwords
Create a new password for the sharing configuration.
Required API key scopes
sharing_configuration:writePath parameters
- recording_idstring
Request parameters
- enabledboolean
- settings
- password_requiredboolean
Response
Example request
POST /api /projects /:project_id /session_recordings /:recording_id /sharing /passwordsExample response
Status 200
Delete session recordings sharing passwords
Delete a password from the sharing configuration.
Required API key scopes
sharing_configuration:writePath parameters
- password_idstring
- recording_idstring
Example request
DELETE /api /projects /:project_id /session_recordings /:recording_id /sharing /passwords /:password_idExample response
Status 204 No response body
Create session recordings sharing refresh
Required API key scopes
sharing_configuration:writePath parameters
- recording_idstring
Request parameters
- enabledboolean
- settings
- password_requiredboolean
Response
Example request
POST /api /projects /:project_id /session_recordings /:recording_id /sharing /refreshExample response
Status 200
List all subscriptions
Also available via the PostHog MCP server:
subscriptions-list— List subscriptions
Required API key scopes
subscription:readQuery parameters
- created_bystring
- dashboardinteger
- insightinteger
- limitinteger
- offsetinteger
- orderingstring
- resource_typestringOne of:
"dashboard""insight" - searchstring
- target_typestringOne of:
"email""slack""webhook"
Response
Example request
GET /api /projects /:project_id /subscriptionsExample response
Status 200
Create subscriptions
Also available via the PostHog MCP server:
subscriptions-create— Create subscription
Required API key scopes
subscription:writeRequest parameters
- dashboardintegernull
- insightintegernull
- dashboard_export_insightsarray
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarraynull
- bysetposintegernull
- countintegernull
- start_datestring
- until_datestringnull
- deletedboolean
- enabledboolean
- titlestringnull
- integration_idintegernull
- invite_messagestringnull
- summary_enabledboolean
- summary_prompt_guidestring
Response
Example request
POST /api /projects /:project_id /subscriptionsExample response
Status 201
Retrieve subscriptions
Also available via the PostHog MCP server:
subscriptions-retrieve— Get subscription
Required API key scopes
subscription:readPath parameters
- idinteger
Response
Example request
GET /api /projects /:project_id /subscriptions /:idExample response
Status 200
Update subscriptions
Also available via the PostHog MCP server:
subscriptions-partial-update— Update subscription
Required API key scopes
subscription:writePath parameters
- idinteger
Request parameters
- dashboardintegernull
- insightintegernull
- dashboard_export_insightsarray
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarraynull
- bysetposintegernull
- countintegernull
- start_datestring
- until_datestringnull
- deletedboolean
- enabledboolean
- titlestringnull
- integration_idintegernull
- invite_messagestringnull
- summary_enabledboolean
- summary_prompt_guidestring
Response
Example request
PATCH /api /projects /:project_id /subscriptions /:idExample response
Status 200
Delete subscriptions
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
subscription:writePath parameters
- idinteger
Example request
DELETE /api /projects /:project_id /subscriptions /:idExample response
Status 405 No response body
Create subscriptions test delivery
Also available via the PostHog MCP server:
subscriptions-test-delivery-create— Send test delivery
Required API key scopes
subscription:writePath parameters
- idinteger
Example request
POST /api /projects /:project_id /subscriptions /:id /test-deliveryExample response
Status 202 Test delivery workflow started
Retrieve subscriptions summary quota
Required API key scopes
subscription:readExample request
GET /api /projects /:project_id /subscriptions /summary_quotaExample response
Status 200 Org-wide AI summary quota: count of currently-active summaries and the limit for the org's plan tier. `limit` is null when no cap is configured.
List all users
Required API key scopes
user:readQuery parameters
- emailstring
- is_staffboolean
- limitinteger
- offsetinteger
Response
Example request
GET /api /usersExample response
Status 200
Retrieve users
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.
Required API key scopes
user:readPath parameters
- uuidstring
Response
Example request
GET /api /users /:uuidExample response
Status 200
Update users
Update one or more of the authenticated user's profile fields or settings.
Required API key scopes
user:writePath parameters
- uuidstring
Request parameters
- first_namestring
- last_namestring
- emailstring
- notification_settingsobject
- anonymize_databooleannull
- allow_impersonationbooleannull
- toolbar_mode
- is_staffboolean
- set_current_organizationstring
- set_current_teamstring
- passwordstring
- current_passwordstring
- events_column_config
- has_seen_product_intro_for
- theme_mode
- hedgehog_config
- allow_sidebar_suggestionsbooleannull
- shortcut_position
- role_at_organization
- passkeys_enabled_for_2fabooleannull
- hide_mcp_hintsboolean
Response
Example request
PATCH /api /users /:uuidExample response
Status 200
Delete users
Path parameters
- uuidstring
Example request
DELETE /api /users /:uuidExample response
Status 204 No response body
Create users credentials review complete
Mark the user as having reviewed their existing credentials. Idempotent. Flips requires_credential_review to False so the post-login interstitial isn't shown again. Does not modify any credentials; the user revokes individual Personal API Keys via the existing PAT endpoints from the same screen.
Path parameters
- uuidstring
Example request
POST /api /users /:uuid /credentials_review_completeExample response
Status 204 No response body
Retrieve users github login
Required API key scopes
user:readPath parameters
- uuidstring
Example request
GET /api /users /:uuid /github_loginExample response
Status 200 No response body
Retrieve users hedgehog config
Required API key scopes
user:readPath parameters
- uuidstring
Example request
GET /api /users /:uuid /hedgehog_configExample response
Status 200 No response body
Update users hedgehog config
Required API key scopes
user:writePath parameters
- uuidstring
Request parameters
- first_namestring
- last_namestring
- emailstring
- notification_settingsobject
- anonymize_databooleannull
- allow_impersonationbooleannull
- toolbar_mode
- is_staffboolean
- set_current_organizationstring
- set_current_teamstring
- passwordstring
- current_passwordstring
- events_column_config
- has_seen_product_intro_for
- theme_mode
- hedgehog_config
- allow_sidebar_suggestionsbooleannull
- shortcut_position
- role_at_organization
- passkeys_enabled_for_2fabooleannull
- hide_mcp_hintsboolean
Example request
PATCH /api /users /:uuid /hedgehog_config