User Home API Reference

User Home

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

Endpoints

`GET`
`PATCH`

Retrieve user home settings

Get the authenticated user's pinned sidebar tabs and configured homepage for the current team. Pass @me as the UUID.

Required API key scopes

user:read

Path parameters

uuid
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "tabs": [
    {
      "id": "string",
      "pathname": "string",
      "search": "string",
      "hash": "string",
      "title": "string",
      "customTitle": "string",
      "iconType": "string",
      "sceneId": "string",
      "sceneKey": "string",
      "sceneParams": null,
      "pinned": true
    }
  ],
  "homepage": {
    "id": "string",
    "pathname": "string",
    "search": "string",
    "hash": "string",
    "title": "string",
    "customTitle": "string",
    "iconType": "string",
    "sceneId": "string",
    "sceneKey": "string",
    "sceneParams": null,
    "pinned": true
  }
}

Update user home settings

Update the authenticated user's pinned sidebar tabs and/or homepage for the current team. Pass @me as the UUID. Send tabs to replace the pinned tab list, homepage to set the home destination (any PostHog URL — dashboard, insight, search results, scene). Either field may be omitted to leave it unchanged; sending homepage: null or {} clears the homepage.

Required API key scopes

user:write

Path parameters

uuid
string

Request parameters

tabs
array
homepage

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "tabs": [
    {
      "id": "string",
      "pathname": "string",
      "search": "string",
      "hash": "string",
      "title": "string",
      "customTitle": "string",
      "iconType": "string",
      "sceneId": "string",
      "sceneKey": "string",
      "sceneParams": null,
      "pinned": true
    }
  ],
  "homepage": {
    "id": "string",
    "pathname": "string",
    "search": "string",
    "hash": "string",
    "title": "string",
    "customTitle": "string",
    "iconType": "string",
    "sceneId": "string",
    "sceneKey": "string",
    "sceneParams": null,
    "pinned": true
  }
}

User Home

Endpoints

Retrieve user home settings

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update user home settings

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Community questions