Users API Reference

Users

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

Endpoints

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

List all users

Required API key scopes

user:read

Query parameters

email
string
is_staff
boolean
limit
integer
offset
integer

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "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": {},
      "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,
      "sensitive_session_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,
        "members_can_invite": true,
        "members_can_use_personal_api_keys": true,
        "allow_publicly_shared_resources": true,
        "member_count": 0,
        "is_ai_data_processing_approved": true,
        "default_experiment_stats_method": "bayesian",
        "default_anonymize_ips": true,
        "default_role_id": "string",
        "is_active": true,
        "is_not_active_reason": "string",
        "is_pending_deletion": 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,
      "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"
        }
      ]
    }
  ]
}

Retrieve users signal autonomy

Per-user signal autonomy config (singleton keyed by user).

GET /api/users/<id>/signal_autonomy/ → current config (or 404) POST /api/users/<id>/signal_autonomy/ → create or update DELETE /api/users/<id>/signal_autonomy/ → remove (opt out)

Required API key scopes

user:write

Path parameters

user_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "user": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com"
  },
  "autostart_priority": "P0",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve users signal autonomy

Per-user signal autonomy config (singleton keyed by user).

GET /api/users/<id>/signal_autonomy/ → current config (or 404) POST /api/users/<id>/signal_autonomy/ → create or update DELETE /api/users/<id>/signal_autonomy/ → remove (opt out)

Required API key scopes

user:write

Path parameters

user_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "user": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com"
  },
  "autostart_priority": "P0",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Create users signal autonomy

Per-user signal autonomy config (singleton keyed by user).

GET /api/users/<id>/signal_autonomy/ → current config (or 404) POST /api/users/<id>/signal_autonomy/ → create or update DELETE /api/users/<id>/signal_autonomy/ → remove (opt out)

Required API key scopes

user:write

Path parameters

user_id
string

Request parameters

autostart_priority

Response

Example request

POST /api/users/:user_id/signal_autonomy
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/:user_id/signal_autonomy/\
	-d user=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{user_id}/signal_autonomy/".format(
        project_id=project_id,
		user_id="<the user id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "user": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com"
  },
  "autostart_priority": "P0",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Create users signal autonomy

Per-user signal autonomy config (singleton keyed by user).

GET /api/users/<id>/signal_autonomy/ → current config (or 404) POST /api/users/<id>/signal_autonomy/ → create or update DELETE /api/users/<id>/signal_autonomy/ → remove (opt out)

Required API key scopes

user:write

Path parameters

user_id
string

Request parameters

autostart_priority

Response

Example request

POST /api/users/:user_id/signal_autonomy
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/:user_id/signal_autonomy/\
	-d user=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{user_id}/signal_autonomy/".format(
        project_id=project_id,
		user_id="<the user id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "user": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com"
  },
  "autostart_priority": "P0",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete users signal autonomy

Per-user signal autonomy config (singleton keyed by user).

GET /api/users/<id>/signal_autonomy/ → current config (or 404) POST /api/users/<id>/signal_autonomy/ → create or update DELETE /api/users/<id>/signal_autonomy/ → remove (opt out)

Required API key scopes

user:write

Path parameters

user_id
string

Example request

DELETE /api/users/:user_id/signal_autonomy
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:user_id/signal_autonomy/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/users/{user_id}/signal_autonomy/".format(
        project_id=project_id,
		user_id="<the user id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Delete users signal autonomy

Per-user signal autonomy config (singleton keyed by user).

GET /api/users/<id>/signal_autonomy/ → current config (or 404) POST /api/users/<id>/signal_autonomy/ → create or update DELETE /api/users/<id>/signal_autonomy/ → remove (opt out)

Required API key scopes

user:write

Path parameters

user_id
string

Example request

DELETE /api/users/:user_id/signal_autonomy
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:user_id/signal_autonomy/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/users/{user_id}/signal_autonomy/".format(
        project_id=project_id,
		user_id="<the user id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

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:read

Path parameters

uuid
string

Response

Example request

GET /api/users/:uuid
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/users/{uuid}/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).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": {},
  "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,
  "sensitive_session_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,
    "members_can_invite": true,
    "members_can_use_personal_api_keys": true,
    "allow_publicly_shared_resources": true,
    "member_count": 0,
    "is_ai_data_processing_approved": true,
    "default_experiment_stats_method": "bayesian",
    "default_anonymize_ips": true,
    "default_role_id": "string",
    "is_active": true,
    "is_not_active_reason": "string",
    "is_pending_deletion": 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,
  "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"
    }
  ]
}

Update users

Update one or more of the authenticated user's profile fields or settings.

Required API key scopes

user:write

Path parameters

uuid
string

Request parameters

first_name
string
last_name
string
email
string
notification_settings
object
anonymize_data
booleannull
allow_impersonation
booleannull
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
booleannull
shortcut_position
role_at_organization
passkeys_enabled_for_2fa
booleannull

Response

Example request

PATCH /api/users/:uuid
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/\
	-d date_joined="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/users/{uuid}/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"date_joined": "string"
	}
).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": {},
  "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,
  "sensitive_session_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,
    "members_can_invite": true,
    "members_can_use_personal_api_keys": true,
    "allow_publicly_shared_resources": true,
    "member_count": 0,
    "is_ai_data_processing_approved": true,
    "default_experiment_stats_method": "bayesian",
    "default_anonymize_ips": true,
    "default_role_id": "string",
    "is_active": true,
    "is_not_active_reason": "string",
    "is_pending_deletion": 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,
  "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"
    }
  ]
}

Delete users

Path parameters

uuid
string

Example request

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

Example response

Status 204 No response body

Retrieve users github login

Required API key scopes

user:read

Path parameters

uuid
string

Example request

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

Example response

Status 200 No response body

Retrieve users hedgehog config

Required API key scopes

user:read

Path parameters

uuid
string

Example request

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

Example response

Status 200 No response body

Update users hedgehog config

Required API key scopes

user:write

Path parameters

uuid
string

Request parameters

first_name
string
last_name
string
email
string
notification_settings
object
anonymize_data
booleannull
allow_impersonation
booleannull
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
booleannull
shortcut_position
role_at_organization
passkeys_enabled_for_2fa
booleannull

Example request

PATCH /api/users/:uuid/hedgehog_config
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/hedgehog_config/\
	-d date_joined="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/users/{uuid}/hedgehog_config/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"date_joined": "string"
	}
).json()

Example response

Status 200 No response body

List all users integrations

/api/users/@me/integrations/ — manage the user's personal GitHub integrations.

Required API key scopes

user:read

Path parameters

uuid
string

Query parameters

limit
integer
offset
integer

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "results": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "kind": "string",
          "installation_id": "string",
          "repository_selection": "string",
          "account": {
            "type": "string",
            "name": "string"
          },
          "uses_shared_installation": true,
          "created_at": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ]
}

Delete users integrations github

Remove a specific GitHub installation by its installation_id.

Required API key scopes

user:write

Path parameters

installation_id
string
uuid
string

Example request

DELETE /api/users/:uuid/integrations/github/:installation_id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/users/:uuid/integrations/github/:installation_id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/users/{uuid}/integrations/github/{installation_id}/".format(
        project_id=project_id,
		installation_id="<the installation id>",,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 Integration removed.

Retrieve users integrations github branches

List branches for a repository accessible to a personal GitHub installation.

Required API key scopes

user:read

Path parameters

installation_id
string
uuid
string

Query parameters

limit
integer
Default: 100
offset
integer
Default: 0
repo
string
search
string
Default:

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "branches": [
    "string"
  ],
  "default_branch": "string",
  "has_more": true
}

Retrieve users integrations github repos

List repositories accessible to a specific GitHub installation (paginated, cached).

Required API key scopes

user:read

Path parameters

installation_id
string
uuid
string

Query parameters

limit
integer
Default: 100
offset
integer
Default: 0
search
string
Default:

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "repositories": [
    {
      "id": 0,
      "name": "string",
      "full_name": "string"
    }
  ],
  "has_more": true
}

Create users integrations github repos refresh

Refresh repositories accessible to a specific GitHub installation.

Required API key scopes

user:write

Path parameters

installation_id
string
uuid
string

Response

Example request

POST /api/users/:uuid/integrations/github/:installation_id/repos/refresh
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/integrations/github/:installation_id/repos/refresh/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/integrations/github/{installation_id}/repos/refresh/".format(
        project_id=project_id,
		installation_id="<the installation id>",,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "repositories": [
    {
      "id": 0,
      "name": "string",
      "full_name": "string"
    }
  ]
}

Create users integrations github start

Start GitHub linking: either full App install or OAuth-only (user-to-server).

**_kwargs absorbs parent_lookup_uuid from the nested /api/users/{uuid}/integrations/ router (same pattern as local_evaluation under projects).

Usually returns install_url pointing at /installations/new so the user can pick any GitHub org (new or already connected). GitHub's install page handles both cases: orgs where the app is installed show "Configure" (no admin needed), orgs where it isn't show "Install" (needs admin).

PostHog Code fast path: when connect_from is "posthog_code", the current project already has a team-level GitHub installation, and the user has no UserIntegration for that installation yet, we skip the org picker and redirect straight to /login/oauth/authorize so the user only authorizes themselves and returns to PostHog Code immediately.

In both cases the response key is install_url for compatibility with callers.

Required API key scopes

user:write

Path parameters

uuid
string

Request parameters

team_id
integernull
connect_from
string

Response

Example request

POST /api/users/:uuid/integrations/github/start
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/integrations/github/start/\
	-d team_id=["integer","null"]
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/users/{uuid}/integrations/github/start/".format(
        project_id=project_id,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"team_id": [
			"integer",
			"null"
		]
	}
).json()

Example response

Status 200

RESPONSE
{
  "install_url": "string",
  "connect_flow": "string"
}