--- aliases: - ../../../http_api/preferences/ # /docs/grafana/next/http_api/preferences/ - ../../../developers/http_api/preferences/ # /docs/grafana/next/developers/http_api/preferences/ canonical: https://grafana.com/docs/grafana/latest/developer-resources/api-reference/http-api/preferences/ description: Grafana HTTP API keywords: - grafana - http - documentation - api - preferences labels: products: - enterprise - oss - cloud title: 'Preferences API' --- # User and Org Preferences API Keys: - **theme** - One of: `light`, `dark`, or an empty string for the default theme - **homeDashboardId** - Deprecated. Use `homeDashboardUID` instead. - **homeDashboardUID**: The `:uid` of a dashboard - **timezone** - One of: `utc`, `browser`, or an empty string for the default Omitting a key will cause the current value to be replaced with the system default value. ## Get Current User Prefs `GET /api/user/preferences` **Example Request**: ```http GET /api/user/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` **Example Response**: ```http HTTP/1.1 200 Content-Type: application/json { "theme": "", "homeDashboardId": 217, "homeDashboardUID": "jcIIG-07z", "timezone": "utc", "weekStart": "", "navbar": { "bookmarkUrls": null }, "queryHistory": { "homeTab": "" } } ``` ## Update Current User Prefs `PUT /api/user/preferences` **Example Request**: ```http PUT /api/user/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "theme": "", "homeDashboardUID":"home", "timezone":"utc" } ``` **Example Response**: ```http HTTP/1.1 200 Content-Type: text/plain; charset=utf-8 {"message":"Preferences updated"} ``` ## Patch Current User Prefs Update one or more preferences without modifying the others. `PATCH /api/user/preferences` **Example Request**: ```http PATCH /api/user/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "theme": "dark" } ``` **Example Response**: ```http HTTP/1.1 200 Content-Type: text/plain; charset=utf-8 {"message":"Preferences updated"} ``` ## Get Current Org Prefs `GET /api/org/preferences` **Example Request**: ```http GET /api/org/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` **Example Response**: ```http HTTP/1.1 200 Content-Type: application/json { "theme": "", "homeDashboardId": 0, "homeDashboardUID": "", "timezone": "", "weekStart": "", "navbar": { "bookmarkUrls": null }, "queryHistory": { "homeTab": "" } } ``` ## Update Current Org Prefs `PUT /api/org/preferences` **Example Request**: ```http PUT /api/org/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "theme": "", "homeDashboardUID":"home", "timezone":"utc" } ``` **Example Response**: ```http HTTP/1.1 200 Content-Type: text/plain; charset=utf-8 {"message":"Preferences updated"} ``` ## Patch Current Org Prefs Update one or more preferences without modifying the others. `PATCH /api/org/preferences` **Example Request**: ```http PATCH /api/org/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "theme": "dark" } ``` **Example Response**: ```http HTTP/1.1 200 Content-Type: text/plain; charset=utf-8 {"message":"Preferences updated"} ```