--- title: "Preferences HTTP API | Grafana Cloud documentation" description: "Grafana Preferences HTTP API" --- > For a curated documentation index, see [llms.txt](/llms.txt). For the complete documentation index, see [llms-full.txt](/llms-full.txt). # Preferences HTTP API > Note > > This API complies with the new Grafana API structure. To learn more refer to documentation about the [API structure in Grafana](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/apis/). > > The Preferences API replaces the legacy [Preferences API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/preferences/). Refer to [Migrate from the legacy Preferences API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#migrate-from-the-legacy-preferences-api) to learn how both APIs match. > > **This document may not contain the latest version of the API. For the most up-to-date list of available endpoints, refer to [preferences.grafana.app/v1](https://play.grafana.org/swagger?api=preferences.grafana.app-v1) in Swagger.** Use this API to read and change user, team, and organization preferences, such as the theme, timezone, home dashboard, and language. All paths use the `preferences.grafana.app` group and the `v1` version. Replace `:namespace` with your namespace. To learn more about which namespace to use, refer to the [API overview](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/apis/). ## Requirements Access depends on who owns the preferences, not on role-based access control actions: Expand table | Owner | Read | Create, update, and delete | |--------------|----------------------------------------------------------|----------------------------------------| | User | The user | The user | | Team | Team members, and users with permission to read the team | Users with permission to edit the team | | Organization | Any user in the organization | Users with the Admin organization role | Organization administrators can’t read or change the preferences of other users. ## Endpoints The following table lists the main endpoints. The Swagger documentation also includes the parameters for watching changes. Expand table | Method | URI | Summary | |--------|---------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| | GET | /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/merged | [Get merged preferences](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#get-merged-preferences) | | GET | /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences | [List preferences](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#list-preferences) | | GET | /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/:name | [Get preferences](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#get-preferences) | | POST | /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences | [Create preferences](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#create-preferences) | | PUT | /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/:name | [Update preferences](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#update-preferences) | | PATCH | /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/:name | [Patch preferences](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#patch-preferences) | | DELETE | /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/:name | [Delete preferences](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#delete-preferences) | ## Preference names and precedence Each preferences object belongs to a user, a team, or the whole organization. Its name, `metadata.name`, identifies the owner: Expand table | Owner | Name | Example | |--------------|-------------------|-----------------| | User | `user-` | `user-a1b2c3d4` | | Team | `team-` | `team-ef5gh6ij` | | Organization | `namespace` | `namespace` | `` and `` are UIDs, not numeric IDs or logins. To get your user UID, use the `uid` field returned by `GET /api/user`. When Grafana applies preferences, it uses the first value set for each field, in this order: 1. The user preferences. 2. The preferences of the user’s teams, in team UID order. Grafana only considers the first 25 teams. 3. The organization preferences. 4. The defaults in the Grafana configuration. To get the result, use [Get merged preferences](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#get-merged-preferences). ## Preferences fields The `spec` of a preferences object has the following fields. All fields are optional. A field that isn’t set falls back to the next level, as described in [Preference names and precedence](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#preference-names-and-precedence). - **theme** – The interface theme. For example, `light`, `dark`, or `system`. An empty string uses the default. - **timezone** – A valid IANA timezone, such as `America/New_York` or `Europe/London`, `utc`, `browser`, or an empty string. - **weekStart** – The first day of the week, in lowercase. For example, `monday`. - **language** – The interface language. For example, `en-US`. - **homeDashboardUID** – The UID of the home dashboard. The reserved value `global-home` uses the instance default home page instead of the home dashboard set at a lower level. An empty string clears the preference. - **navbar.bookmarkUrls** – The URLs bookmarked in the navigation menu. - **queryHistory.homeTab** – The default tab of the Explore query history: `query`, `starred`, or an empty string. - **homeURL** – Read-only. The home URL from the `home_page` setting in the Grafana configuration. You can’t set it through the API. ## Get merged preferences `GET /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/merged` Returns the preferences that apply to you, after combining your user, team, and organization preferences with the configured defaults. - `namespace`: To learn more about which namespace to use, refer to the [API overview](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/apis/). **Required permissions**: None. The response only includes the preferences that apply to you. **Example request**: http ![Copy code to clipboard](https://grafana.com/media/images/icons/icon-copy-small-2.svg) Copy ```http GET /apis/preferences.grafana.app/v1/namespaces/default/preferences/merged HTTP/1.1 Accept: application/json Authorization: Bearer ``` **Example response**: http ![Copy code to clipboard](https://grafana.com/media/images/icons/icon-copy-small-2.svg) Copy ```http HTTP/1.1 200 Content-Type: application/json { "kind": "Preferences", "apiVersion": "preferences.grafana.app/v1", "metadata": { "resourceVersion": "1762327800000", "creationTimestamp": "2026-11-05T07:30:00Z", "annotations": { "preferences.grafana.app/source": "user-a1b2c3d4,namespace" } }, "spec": { "theme": "dark", "timezone": "utc", "weekStart": "monday", "language": "en-US", "homeDashboardUID": "jcIIG-07z" } } ``` The `preferences.grafana.app/source` annotation lists the preferences objects that were combined, from highest to lowest precedence. The `resourceVersion` changes when any of them changes. Status codes: - **200** – OK - **401** – Unauthorized ## List preferences `GET /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences` Returns the preferences objects that apply to you: your user preferences, the preferences of your first 25 teams, and the organization preferences. Objects that don’t exist aren’t included. Service accounts only get the organization preferences. - `namespace`: To learn more about which namespace to use, refer to the [API overview](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/apis/). **Query parameters**: - **`fieldSelector`** (optional): Use `metadata.name=` to get a single preferences object. No other field selector is supported. The API doesn’t support pagination with `continue`, or filtering with `labelSelector`. **Required permissions**: None. The response only includes the preferences you can read. **Example request**: http ![Copy code to clipboard](https://grafana.com/media/images/icons/icon-copy-small-2.svg) Copy ```http GET /apis/preferences.grafana.app/v1/namespaces/default/preferences HTTP/1.1 Accept: application/json Authorization: Bearer ``` **Example response**: http ![Copy code to clipboard](https://grafana.com/media/images/icons/icon-copy-small-2.svg) Copy ```http HTTP/1.1 200 Content-Type: application/json { "kind": "PreferencesList", "apiVersion": "preferences.grafana.app/v1", "metadata": {}, "items": [ { "kind": "Preferences", "apiVersion": "preferences.grafana.app/v1", "metadata": { "name": "user-a1b2c3d4", "namespace": "default", "resourceVersion": "1762327800000", "creationTimestamp": "2026-11-05T07:30:00Z" }, "spec": { "theme": "dark", "homeDashboardUID": "jcIIG-07z" } }, { "kind": "Preferences", "apiVersion": "preferences.grafana.app/v1", "metadata": { "name": "namespace", "namespace": "default", "resourceVersion": "1762320000000", "creationTimestamp": "2026-11-05T05:20:00Z" }, "spec": { "timezone": "utc", "weekStart": "monday" } } ] } ``` Status codes: - **200** – OK - **401** – Unauthorized ## Get preferences `GET /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/:name` Returns the preferences object with the given name. - `namespace`: To learn more about which namespace to use, refer to the [API overview](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/apis/). - `name`: `user-`, `team-`, or `namespace`. **Required permissions**: Read access for the owner. Refer to [Requirements](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#requirements). **Example request**: http ![Copy code to clipboard](https://grafana.com/media/images/icons/icon-copy-small-2.svg) Copy ```http GET /apis/preferences.grafana.app/v1/namespaces/default/preferences/user-a1b2c3d4 HTTP/1.1 Accept: application/json Authorization: Bearer ``` **Example response**: http ![Copy code to clipboard](https://grafana.com/media/images/icons/icon-copy-small-2.svg) Copy ```http HTTP/1.1 200 Content-Type: application/json { "kind": "Preferences", "apiVersion": "preferences.grafana.app/v1", "metadata": { "name": "user-a1b2c3d4", "namespace": "default", "resourceVersion": "1762327800000", "creationTimestamp": "2026-11-05T07:30:00Z" }, "spec": { "theme": "dark", "homeDashboardUID": "jcIIG-07z" } } ``` Status codes: - **200** – Found - **401** – Unauthorized - **403** – Access denied - **404** – No preferences are saved for this owner ## Create preferences `POST /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences` Creates the preferences for a user, a team, or the organization. You can also use [Update preferences](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#update-preferences), which creates the object if it doesn’t exist yet. - `namespace`: To learn more about which namespace to use, refer to the [API overview](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/apis/). **Required permissions**: Write access for the owner. Refer to [Requirements](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#requirements). **Example request**: http ![Copy code to clipboard](https://grafana.com/media/images/icons/icon-copy-small-2.svg) Copy ```http POST /apis/preferences.grafana.app/v1/namespaces/default/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer { "metadata": { "name": "team-ef5gh6ij" }, "spec": { "theme": "light", "homeDashboardUID": "jcIIG-07z" } } ``` JSON body schema: - **metadata.name** – Required. `user-`, `team-`, or `namespace`. - **spec** – The preferences. For details, refer to [Preferences fields](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#preferences-fields). **Example response**: http ![Copy code to clipboard](https://grafana.com/media/images/icons/icon-copy-small-2.svg) Copy ```http HTTP/1.1 201 Content-Type: application/json { "kind": "Preferences", "apiVersion": "preferences.grafana.app/v1", "metadata": { "name": "team-ef5gh6ij", "namespace": "default", "resourceVersion": "1762328000000", "creationTimestamp": "2026-11-05T07:33:20Z" }, "spec": { "theme": "light", "homeDashboardUID": "jcIIG-07z" } } ``` Status codes: - **201** – Created - **400** – Errors (invalid JSON) - **401** – Unauthorized - **403** – Access denied - **409** – Preferences already exist for this owner - **422** – Invalid preferences, for example an unknown theme or timezone, or a `homeURL` value ## Update preferences `PUT /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/:name` Replaces the preferences with the given name. If no preferences exist for the owner yet, Grafana creates them. Fields you omit are cleared, so they fall back to the next level. - `namespace`: To learn more about which namespace to use, refer to the [API overview](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/apis/). - `name`: `user-`, `team-`, or `namespace`. **Required permissions**: Write access for the owner. Refer to [Requirements](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#requirements). **Example request**: http ![Copy code to clipboard](https://grafana.com/media/images/icons/icon-copy-small-2.svg) Copy ```http PUT /apis/preferences.grafana.app/v1/namespaces/default/preferences/namespace HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer { "metadata": { "name": "namespace" }, "spec": { "theme": "", "timezone": "utc", "weekStart": "monday", "homeDashboardUID": "jcIIG-07z" } } ``` JSON body schema: - **metadata.name** – Required. It must match `name` in the path. - **metadata.resourceVersion** – Optional. The resource version you’re updating. If the preferences changed since you read them, the request fails with `409`. - **spec** – The complete preferences. For details, refer to [Preferences fields](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#preferences-fields). The response contains the updated preferences. Status codes: - **200** – Updated - **201** – Created - **400** – Errors (invalid JSON) - **401** – Unauthorized - **403** – Access denied - **409** – Conflict, the preferences changed since you read them - **422** – Invalid preferences, for example an unknown theme or timezone, or a `homeURL` value ## Patch preferences `PATCH /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/:name` Updates one or more preferences without changing the others. If no preferences exist for the owner yet, Grafana creates them. - `namespace`: To learn more about which namespace to use, refer to the [API overview](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/apis/). - `name`: `user-`, `team-`, or `namespace`. **Required permissions**: Write access for the owner. Refer to [Requirements](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#requirements). **Example request**: http ![Copy code to clipboard](https://grafana.com/media/images/icons/icon-copy-small-2.svg) Copy ```http PATCH /apis/preferences.grafana.app/v1/namespaces/default/preferences/user-a1b2c3d4 HTTP/1.1 Accept: application/json Content-Type: application/merge-patch+json Authorization: Bearer { "spec": { "theme": "dark" } } ``` The response contains the updated preferences. Status codes: - **200** – Updated - **201** – Created - **401** – Unauthorized - **403** – Access denied - **422** – Invalid preferences, for example an unknown theme or timezone, or a `homeURL` value ## Delete preferences `DELETE /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/:name` Deletes the preferences with the given name. After that, every field falls back to the next level. - `namespace`: To learn more about which namespace to use, refer to the [API overview](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/apis/). - `name`: `user-`, `team-`, or `namespace`. **Required permissions**: Write access for the owner. Refer to [Requirements](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#requirements). **Example request**: http ![Copy code to clipboard](https://grafana.com/media/images/icons/icon-copy-small-2.svg) Copy ```http DELETE /apis/preferences.grafana.app/v1/namespaces/default/preferences/user-a1b2c3d4 HTTP/1.1 Accept: application/json Authorization: Bearer ``` Status codes: - **200** – Deleted - **401** – Unauthorized - **403** – Access denied - **404** – No preferences are saved for this owner ## Migrate from the legacy Preferences API The legacy API has separate endpoints for the current user, the current organization, and teams. The new API uses one resource, and the name selects the owner: Expand table | Legacy endpoint | New endpoint | |--------------------------------------|--------------------------------------------------------------------------------------------| | `GET /api/user/preferences` | `GET /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/user-` | | `PUT /api/user/preferences` | `PUT /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/user-` | | `PATCH /api/user/preferences` | `PATCH /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/user-` | | `GET /api/org/preferences` | `GET /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/namespace` | | `PUT /api/org/preferences` | `PUT /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/namespace` | | `PATCH /api/org/preferences` | `PATCH /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/namespace` | | `GET /api/teams/:teamId/preferences` | `GET /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/team-` | | `PUT /api/teams/:teamId/preferences` | `PUT /apis/preferences.grafana.app/v1/namespaces/:namespace/preferences/team-` | When you migrate, consider the following differences: - **Team preferences:** The legacy [team preferences endpoints](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/team/) use the numeric team ID. The new API uses the team UID. - **Home dashboard:** `homeDashboardId` isn’t available. Use `homeDashboardUID`. - **Effective preferences:** The legacy API has no equivalent of [Get merged preferences](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/#get-merged-preferences). - **Responses:** Updates return the saved preferences object instead of a `{"message":"Preferences updated"}` message.