Users

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

`POST`
`PATCH`
`POST`
`POST`
`POST`
`GET`
`POST`
`POST`
`GET`
`GET`

← Previous pageNext page →

Create users onboarding skip

Mark the current user as having exited onboarding with a non-delegated reason. Idempotent: the skip timestamp is only set on the first successful call.

Callers wanting to delegate setup to a teammate must use the dedicated /organizations/{id}/invites/delegate/ endpoint, which atomically creates the invite and sets reason="delegated". This endpoint rejects that reason so state can't be faked without a real invite.

Path parameters

uuid
string

Request parameters

reason
step_at_skip
string

Response

Example request

POST /api/users/:uuid/onboarding/skip
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/onboarding/skip/\
	-d reason=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/onboarding/skip/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "date_joined": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "distinct_id": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "pending_email": "user@example.com",
  "is_email_verified": true,
  "notification_settings": {},
  "notification_locks": [
    {
      "setting": "data_catalog_weekly_digest",
      "scope_id": "string",
      "locked_value": true
    }
  ],
  "anonymize_data": true,
  "allow_impersonation": true,
  "toolbar_mode": "disabled",
  "has_password": true,
  "id": 0,
  "is_staff": true,
  "is_impersonated": true,
  "is_impersonated_until": "string",
  "is_impersonated_read_only": true,
  "is_impersonated_reason": "string",
  "sensitive_session_expires_at": "string",
  "fresh_reauth_expires_at": "string",
  "team": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
    "project_id": -9223372036854776000,
    "api_token": "string",
    "name": "string",
    "completed_snippet_onboarding": true,
    "has_completed_onboarding_for": null,
    "ingested_event": true,
    "is_demo": true,
    "timezone": "Africa/Abidjan",
    "access_control": true
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "slug": "string",
    "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "membership_level": 1,
    "plugins_access_level": 0,
    "teams": [
      {}
    ],
    "projects": [
      {}
    ],
    "available_product_features": [
      null
    ],
    "is_member_join_email_enabled": true,
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "customer_id": "string",
    "enforce_2fa": true,
    "enforce_verified_domains": true,
    "members_can_invite": true,
    "members_can_create_projects": true,
    "members_can_use_personal_api_keys": true,
    "members_can_see_org_members": true,
    "allow_publicly_shared_resources": true,
    "read_only_mcp_access": true,
    "member_count": 0,
    "is_ai_data_processing_approved": true,
    "is_ai_training_opted_in": true,
    "is_ai_training_locked": true,
    "is_ai_training_cta_shown": true,
    "has_signed_baa": true,
    "default_anonymize_ips": true,
    "default_role_id": "f16726e8-3b54-4d9b-a01f-a76d5a80658c",
    "is_active": true,
    "is_not_active_reason": "string",
    "is_pending_deletion": true,
    "uses_most_specific_access_resolution": true
  },
  "organizations": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
      "membership_level": 1,
      "members_can_use_personal_api_keys": true,
      "is_active": true,
      "is_not_active_reason": "string",
      "is_pending_deletion": true
    }
  ],
  "set_current_organization": "string",
  "set_current_team": "string",
  "password": "string",
  "current_password": "string",
  "events_column_config": null,
  "is_2fa_enabled": true,
  "has_social_auth": true,
  "has_sso_enforcement": true,
  "has_seen_product_intro_for": null,
  "scene_personalisation": [
    {
      "scene": "string",
      "dashboard": 0
    }
  ],
  "theme_mode": "light",
  "hedgehog_config": null,
  "allow_sidebar_suggestions": true,
  "shortcut_position": "above",
  "role_at_organization": "engineering",
  "passkeys_enabled_for_2fa": true,
  "hide_mcp_hints": true,
  "ui_configuration": null,
  "onboarding_skipped_at": "2019-08-24T14:15:22Z",
  "onboarding_skipped_reason": "delegated",
  "onboarding_skipped_organization_id": "07d05e34-b1e4-4d27-bda6-e0475982a5c6",
  "onboarding_delegated_to_invite": "5b84e4d7-3fe6-4b27-ad86-bc5c82f39436",
  "onboarding_delegated_to_organization_id": "cc1d8401-81fd-4ff9-836c-1740f15ea5c2",
  "onboarding_delegation_accepted_at": "2019-08-24T14:15:22Z",
  "is_organization_first_user": true,
  "active_realtime_notification_types": [
    "string"
  ],
  "pending_invites": [
    {
      "id": "string",
      "target_email": "user@example.com",
      "organization_id": "string",
      "organization_name": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "requires_credential_review": true
}

Create users onboarding skip

Mark the current user as having exited onboarding with a non-delegated reason. Idempotent: the skip timestamp is only set on the first successful call.

Path parameters

uuid
string

Request parameters

reason
step_at_skip
string

Response

Example request

POST /api/users/:uuid/onboarding/skip
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/onboarding/skip/\
	-d reason=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/onboarding/skip/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "date_joined": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "distinct_id": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "pending_email": "user@example.com",
  "is_email_verified": true,
  "notification_settings": {},
  "notification_locks": [
    {
      "setting": "data_catalog_weekly_digest",
      "scope_id": "string",
      "locked_value": true
    }
  ],
  "anonymize_data": true,
  "allow_impersonation": true,
  "toolbar_mode": "disabled",
  "has_password": true,
  "id": 0,
  "is_staff": true,
  "is_impersonated": true,
  "is_impersonated_until": "string",
  "is_impersonated_read_only": true,
  "is_impersonated_reason": "string",
  "sensitive_session_expires_at": "string",
  "fresh_reauth_expires_at": "string",
  "team": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
    "project_id": -9223372036854776000,
    "api_token": "string",
    "name": "string",
    "completed_snippet_onboarding": true,
    "has_completed_onboarding_for": null,
    "ingested_event": true,
    "is_demo": true,
    "timezone": "Africa/Abidjan",
    "access_control": true
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "slug": "string",
    "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "membership_level": 1,
    "plugins_access_level": 0,
    "teams": [
      {}
    ],
    "projects": [
      {}
    ],
    "available_product_features": [
      null
    ],
    "is_member_join_email_enabled": true,
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "customer_id": "string",
    "enforce_2fa": true,
    "enforce_verified_domains": true,
    "members_can_invite": true,
    "members_can_create_projects": true,
    "members_can_use_personal_api_keys": true,
    "members_can_see_org_members": true,
    "allow_publicly_shared_resources": true,
    "read_only_mcp_access": true,
    "member_count": 0,
    "is_ai_data_processing_approved": true,
    "is_ai_training_opted_in": true,
    "is_ai_training_locked": true,
    "is_ai_training_cta_shown": true,
    "has_signed_baa": true,
    "default_anonymize_ips": true,
    "default_role_id": "f16726e8-3b54-4d9b-a01f-a76d5a80658c",
    "is_active": true,
    "is_not_active_reason": "string",
    "is_pending_deletion": true,
    "uses_most_specific_access_resolution": true
  },
  "organizations": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
      "membership_level": 1,
      "members_can_use_personal_api_keys": true,
      "is_active": true,
      "is_not_active_reason": "string",
      "is_pending_deletion": true
    }
  ],
  "set_current_organization": "string",
  "set_current_team": "string",
  "password": "string",
  "current_password": "string",
  "events_column_config": null,
  "is_2fa_enabled": true,
  "has_social_auth": true,
  "has_sso_enforcement": true,
  "has_seen_product_intro_for": null,
  "scene_personalisation": [
    {
      "scene": "string",
      "dashboard": 0
    }
  ],
  "theme_mode": "light",
  "hedgehog_config": null,
  "allow_sidebar_suggestions": true,
  "shortcut_position": "above",
  "role_at_organization": "engineering",
  "passkeys_enabled_for_2fa": true,
  "hide_mcp_hints": true,
  "ui_configuration": null,
  "onboarding_skipped_at": "2019-08-24T14:15:22Z",
  "onboarding_skipped_reason": "delegated",
  "onboarding_skipped_organization_id": "07d05e34-b1e4-4d27-bda6-e0475982a5c6",
  "onboarding_delegated_to_invite": "5b84e4d7-3fe6-4b27-ad86-bc5c82f39436",
  "onboarding_delegated_to_organization_id": "cc1d8401-81fd-4ff9-836c-1740f15ea5c2",
  "onboarding_delegation_accepted_at": "2019-08-24T14:15:22Z",
  "is_organization_first_user": true,
  "active_realtime_notification_types": [
    "string"
  ],
  "pending_invites": [
    {
      "id": "string",
      "target_email": "user@example.com",
      "organization_id": "string",
      "organization_name": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "requires_credential_review": true
}

Update users product intro seen

Record that this user has seen one product intro.

Separate from the has_seen_product_intro_for field on the main user PATCH, which requires a recently authenticated session. Dismissing an intro must not depend on that: a re-auth prompt would cover the intro it interrupts, and the dismissal would never persist. Nothing reachable here changes an account, an organization, or a profile.

Merging server-side also keeps two intros dismissed from separate tabs from dropping each other's key, which a read-modify-write of the whole map cannot avoid.

Required API key scopes

user:write

Path parameters

uuid
string

Request parameters

product_key
string
seen
boolean
Default: true

Example request

PATCH /api/users/:uuid/product_intro_seen
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/product_intro_seen/\
	-d product_key="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/users/{uuid}/product_intro_seen/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"product_key": "string"
	}
).json()

Example response

Status 200 The user's whole `has_seen_product_intro_for` map, after the merge.

Update users product intro seen

Record that this user has seen one product intro.

Merging server-side also keeps two intros dismissed from separate tabs from dropping each other's key, which a read-modify-write of the whole map cannot avoid.

Required API key scopes

user:write

Path parameters

uuid
string

Request parameters

product_key
string
seen
boolean
Default: true

Example request

PATCH /api/users/:uuid/product_intro_seen
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/product_intro_seen/\
	-d product_key="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/users/{uuid}/product_intro_seen/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"product_key": "string"
	}
).json()

Example response

Status 200 The user's whole `has_seen_product_intro_for` map, after the merge.

Create users push tokens

Idempotent upsert: if the (user, token) pair already exists, platform and last_seen_at are refreshed. Otherwise a new row is created.

Required API key scopes

user:write

Path parameters

uuid
string

Request parameters

token
string
platform

Response

Example request

POST /api/users/:uuid/push_tokens
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/push_tokens/\
	-d token="string",\
	-d platform=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/push_tokens/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"token": "string"
	}
).json()

Example response

Status 200 Token was registered or refreshed.

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "platform": "ios",
  "created_at": "2019-08-24T14:15:22Z",
  "last_seen_at": "2019-08-24T14:15:22Z"
}

Create users push tokens

Idempotent upsert: if the (user, token) pair already exists, platform and last_seen_at are refreshed. Otherwise a new row is created.

Required API key scopes

user:write

Path parameters

uuid
string

Request parameters

token
string
platform

Response

Example request

POST /api/users/:uuid/push_tokens
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/push_tokens/\
	-d token="string",\
	-d platform=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/push_tokens/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"token": "string"
	}
).json()

Example response

Status 200 Token was registered or refreshed.

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "platform": "ios",
  "created_at": "2019-08-24T14:15:22Z",
  "last_seen_at": "2019-08-24T14:15:22Z"
}

Create users push tokens unregister

Delete the row matching (user, token). Returns 204 even if no row matches so the mobile client can call this unconditionally when the user opts out.

Required API key scopes

user:write

Path parameters

uuid
string

Request parameters

token
string

Example request

POST /api/users/:uuid/push_tokens/unregister
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/push_tokens/unregister/\
	-d token="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/push_tokens/unregister/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"token": "string"
	}
).json()

Example response

Status 204 Token removed (or never existed).

Create users push tokens unregister

Delete the row matching (user, token). Returns 204 even if no row matches so the mobile client can call this unconditionally when the user opts out.

Required API key scopes

user:write

Path parameters

uuid
string

Request parameters

token
string

Example request

POST /api/users/:uuid/push_tokens/unregister
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/push_tokens/unregister/\
	-d token="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/push_tokens/unregister/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"token": "string"
	}
).json()

Example response

Status 204 Token removed (or never existed).

Create users scene personalisation

Path parameters

uuid
string

Request parameters

first_name
string
last_name
string
email
string
notification_settings
object
anonymize_data
boolean | null
allow_impersonation
boolean | null
toolbar_mode
is_staff
boolean
set_current_organization
string
set_current_team
string
password
string
current_password
string
events_column_config
has_seen_product_intro_for
theme_mode
hedgehog_config
allow_sidebar_suggestions
boolean | null
shortcut_position
role_at_organization
passkeys_enabled_for_2fa
boolean | null
hide_mcp_hints
boolean
ui_configuration

Example request

POST /api/users/:uuid/scene_personalisation
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/scene_personalisation/\
	-d email="string",\
	-d password="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/scene_personalisation/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"email": "string",
		"password": "string"
	}
).json()

Example response

Status 200 No response body

Create users scene personalisation

Path parameters

uuid
string

Request parameters

first_name
string
last_name
string
email
string
notification_settings
object
anonymize_data
boolean | null
allow_impersonation
boolean | null
toolbar_mode
is_staff
boolean
set_current_organization
string
set_current_team
string
password
string
current_password
string
events_column_config
has_seen_product_intro_for
theme_mode
hedgehog_config
allow_sidebar_suggestions
boolean | null
shortcut_position
role_at_organization
passkeys_enabled_for_2fa
boolean | null
hide_mcp_hints
boolean
ui_configuration

Example request

POST /api/users/:uuid/scene_personalisation
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/scene_personalisation/\
	-d email="string",\
	-d password="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/scene_personalisation/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"email": "string",
		"password": "string"
	}
).json()

Example response

Status 200 No response body

Retrieve users start 2fa setup

Path parameters

uuid
string

Example request

GET /api/users/:uuid/start_2fa_setup
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/start_2fa_setup/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/users/{uuid}/start_2fa_setup/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve users start 2fa setup

Path parameters

uuid
string

Example request

GET /api/users/:uuid/start_2fa_setup
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/start_2fa_setup/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/users/{uuid}/start_2fa_setup/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create users two factor backup codes

Generate new backup codes, invalidating any existing ones

Path parameters

uuid
string

Request parameters

first_name
string
last_name
string
email
string
notification_settings
object
anonymize_data
boolean | null
allow_impersonation
boolean | null
toolbar_mode
is_staff
boolean
set_current_organization
string
set_current_team
string
password
string
current_password
string
events_column_config
has_seen_product_intro_for
theme_mode
hedgehog_config
allow_sidebar_suggestions
boolean | null
shortcut_position
role_at_organization
passkeys_enabled_for_2fa
boolean | null
hide_mcp_hints
boolean
ui_configuration

Example request

POST /api/users/:uuid/two_factor_backup_codes
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/two_factor_backup_codes/\
	-d email="string",\
	-d password="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/two_factor_backup_codes/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"email": "string",
		"password": "string"
	}
).json()

Example response

Status 200 No response body

Create users two factor backup codes

Generate new backup codes, invalidating any existing ones

Path parameters

uuid
string

Request parameters

first_name
string
last_name
string
email
string
notification_settings
object
anonymize_data
boolean | null
allow_impersonation
boolean | null
toolbar_mode
is_staff
boolean
set_current_organization
string
set_current_team
string
password
string
current_password
string
events_column_config
has_seen_product_intro_for
theme_mode
hedgehog_config
allow_sidebar_suggestions
boolean | null
shortcut_position
role_at_organization
passkeys_enabled_for_2fa
boolean | null
hide_mcp_hints
boolean
ui_configuration

Example request

POST /api/users/:uuid/two_factor_backup_codes
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/two_factor_backup_codes/\
	-d email="string",\
	-d password="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/two_factor_backup_codes/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"email": "string",
		"password": "string"
	}
).json()

Example response

Status 200 No response body

Create users two factor disable

Disable 2FA and remove all related devices

Path parameters

uuid
string

Request parameters

first_name
string
last_name
string
email
string
notification_settings
object
anonymize_data
boolean | null
allow_impersonation
boolean | null
toolbar_mode
is_staff
boolean
set_current_organization
string
set_current_team
string
password
string
current_password
string
events_column_config
has_seen_product_intro_for
theme_mode
hedgehog_config
allow_sidebar_suggestions
boolean | null
shortcut_position
role_at_organization
passkeys_enabled_for_2fa
boolean | null
hide_mcp_hints
boolean
ui_configuration

Example request

POST /api/users/:uuid/two_factor_disable
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/two_factor_disable/\
	-d email="string",\
	-d password="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/two_factor_disable/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"email": "string",
		"password": "string"
	}
).json()

Example response

Status 200 No response body

Create users two factor disable

Disable 2FA and remove all related devices

Path parameters

uuid
string

Request parameters

first_name
string
last_name
string
email
string
notification_settings
object
anonymize_data
boolean | null
allow_impersonation
boolean | null
toolbar_mode
is_staff
boolean
set_current_organization
string
set_current_team
string
password
string
current_password
string
events_column_config
has_seen_product_intro_for
theme_mode
hedgehog_config
allow_sidebar_suggestions
boolean | null
shortcut_position
role_at_organization
passkeys_enabled_for_2fa
boolean | null
hide_mcp_hints
boolean
ui_configuration

Example request

POST /api/users/:uuid/two_factor_disable
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/two_factor_disable/\
	-d email="string",\
	-d password="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/two_factor_disable/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"email": "string",
		"password": "string"
	}
).json()

Example response

Status 200 No response body

Retrieve users two factor start setup

Path parameters

uuid
string

Example request

GET /api/users/:uuid/two_factor_start_setup
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/two_factor_start_setup/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/users/{uuid}/two_factor_start_setup/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve users two factor start setup

Path parameters

uuid
string

Example request

GET /api/users/:uuid/two_factor_start_setup
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/two_factor_start_setup/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/users/{uuid}/two_factor_start_setup/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve users two factor status

Get current 2FA status, including how many backup codes are left.

Path parameters

uuid
string

Response

Example request

GET /api/users/:uuid/two_factor_status
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/two_factor_status/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/users/{uuid}/two_factor_status/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "is_enabled": true,
  "backup_codes_remaining": 0,
  "method": "string",
  "has_passkeys": true,
  "has_totp": true,
  "passkeys_enabled_for_2fa": true
}

Retrieve users two factor status

Get current 2FA status, including how many backup codes are left.

Path parameters

uuid
string

Response

Example request

GET /api/users/:uuid/two_factor_status
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/two_factor_status/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/users/{uuid}/two_factor_status/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "is_enabled": true,
  "backup_codes_remaining": 0,
  "method": "string",
  "has_passkeys": true,
  "has_totp": true,
  "passkeys_enabled_for_2fa": true
}

← Previous pageNext page →