Users

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

Endpoints

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

← Previous pageNext page →

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

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
hide_mcp_hints
boolean
ui_configuration

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

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
hide_mcp_hints
boolean
ui_configuration

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

Return the authenticated user's personal integrations of a given kind (github or slack).

The response shape varies per kind because the underlying UserIntegration rows carry different identity fields — GitHub rows expose installation_id / account / uses_shared_installation; Slack rows expose slack_user_id / slack_team_id / slack_team_name. Kind-specific destroy and start actions remain split so their distinct semantics (e.g. Slack's lack of "uninstall on last reference") stay explicit at the URL layer.

Default of kind=github is load-bearing: mobile (apps/mobile/...) and the Code SDK (packages/api-client/...) both call this endpoint without a query param today and rely on receiving GitHub rows.

Required API key scopes

user:read

Path parameters

uuid
string

Query parameters

kind
string
One of: "github""slack"
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"
          },
          "github_login": "string",
          "uses_shared_installation": true,
          "installation_shared": true,
          "installation_status": "connected",
          "created_at": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ]
}

List all users integrations

Return the authenticated user's personal integrations of a given kind (github or slack).

Required API key scopes

user:read

Path parameters

uuid
string

Query parameters

kind
string
One of: "github""slack"
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"
          },
          "github_login": "string",
          "uses_shared_installation": true,
          "installation_shared": true,
          "installation_status": "connected",
          "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.

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 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",
      "private": true,
      "default_branch": "string",
      "language": "string",
      "pushed_at": "string",
      "archived": true,
      "can_push": true
    }
  ],
  "has_more": true,
  "total": 0
}

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",
      "private": true,
      "default_branch": "string",
      "language": "string",
      "pushed_at": "string",
      "archived": true,
      "can_push": true
    }
  ],
  "has_more": true,
  "total": 0
}

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",
      "private": true,
      "default_branch": "string",
      "language": "string",
      "pushed_at": "string",
      "archived": true,
      "can_push": true
    }
  ],
  "installation_status": "connected"
}

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",
      "private": true,
      "default_branch": "string",
      "language": "string",
      "pushed_at": "string",
      "archived": true,
      "can_push": true
    }
  ],
  "installation_status": "connected"
}

Retrieve users integrations github install requests

Return the requesting user's GitHub App install-approval requests, newest first.

This is the durable server-side "awaiting org owner approval" state (see posthog.models.user_integration.GitHubInstallRequest), distinct from the in-flight connect spinner, which never touches this table.

Required API key scopes

user:read

Path parameters

uuid
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "github_login": "string",
      "status": "pending",
      "installation_id": "string",
      "account_login": "string",
      "account_type": "string",
      "requested_at": "2019-08-24T14:15:22Z",
      "resolved_at": "2019-08-24T14:15:22Z"
    }
  ],
  "install_url": "string"
}

Retrieve users integrations github install requests

Return the requesting user's GitHub App install-approval requests, newest first.

Required API key scopes

user:read

Path parameters

uuid
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "github_login": "string",
      "status": "pending",
      "installation_id": "string",
      "account_login": "string",
      "account_type": "string",
      "requested_at": "2019-08-24T14:15:22Z",
      "resolved_at": "2019-08-24T14:15:22Z"
    }
  ],
  "install_url": "string"
}

Delete users integrations github install requests

Delete one of the requesting user's install-approval requests, whatever its status.

User-facing bookkeeping only: a later connect attempt records a fresh row.

Required API key scopes

user:write

Path parameters

request_id
string
uuid
string

Example request

DELETE /api/users/:uuid/integrations/github/install_requests/:request_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/install_requests/:request_id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/users/{uuid}/integrations/github/install_requests/{request_id}/".format(
        project_id=project_id,
		request_id="<the request id>",,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 Request dismissed.

Delete users integrations github install requests

Delete one of the requesting user's install-approval requests, whatever its status.

User-facing bookkeeping only: a later connect attempt records a fresh row.

Required API key scopes

user:write

Path parameters

request_id
string
uuid
string

Example request

DELETE /api/users/:uuid/integrations/github/install_requests/:request_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/install_requests/:request_id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/users/{uuid}/integrations/github/install_requests/{request_id}/".format(
        project_id=project_id,
		request_id="<the request id>",,
		uuid="<the uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 Request dismissed.

Create users integrations github prepare callback

Seed personal GitHub manage callback state before opening installation settings on GitHub.

Required API key scopes

user:write

Path parameters

uuid
string

Request parameters

installation_id
string

Example request

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

Example response

Status 204 No content

Create users integrations github prepare callback

Seed personal GitHub manage callback state before opening installation settings on GitHub.

Required API key scopes

user:write

Path parameters

uuid
string

Request parameters

installation_id
string

Example request

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

Example response

Status 204 No content

← Previous pageNext page →