---
title: "Get the caller's stored app preferences"
method: GET
path: "/compat/v2/users/getPreferences"
tags: ["users"]
---

# Get the caller's stored app preferences

`GET /compat/v2/users/getPreferences`

## Response `200`

Successful response

- object, nullable
  - `preferencesVersion` integer, required
  - `global.enableSplitPane` boolean, required
  - `global.language` 'en-us' | 'it-it' | 'de-de' | 'uk-ua' | 'he' | 'es-es' | 'fr-fr' | 'ru-ru' | 'hu-hu' | 'da-dk' | 'zh-cn' | 'pt-pt' | 'pt-br' | 'nl' | 'pl' | 'ja' | 'lt' | 'eu' | 'el' | 'fi' | 'sv' | 'ro' | 'cs' | 'ar-sa' | 'hi' | 'es-mx' | 'ko' | 'nb-no' | 'tr' | 'zh-hant', nullable, required
  - `global.fontSize` '1rem' | '14px' | '16px' | '18px' | '20px' | '22px' | '24px', required
  - `global.theme` 'default' | 'light' | 'dark' | 'black' | 'midnight', required
  - `global.preferencesSync` 'enabled' | 'disabled', required
  - `global.startPage` 'myRecipes' | 'manageLabels' | 'mealPlans' | 'shoppingLists', required
  - `global.offlineModePrompt` 'ask' | 'never', required
  - `myRecipes.enableLabelIntersection` boolean, required
  - `myRecipes.showLabels` boolean, required
  - `myRecipes.showLabelChips` boolean, required
  - `myRecipes.showImages` boolean, required
  - `myRecipes.showSource` boolean, required
  - `myRecipes.showRecipeDescription` boolean, required
  - `myRecipes.showRating` boolean, required
  - `myRecipes.viewType` 'tiles' | 'list' | 'compact', required
  - `myRecipes.sortBy` 'title' | '-createdAt' | 'createdAt' | '-updatedAt' | 'updatedAt' | '-lastMadeAt' | 'lastMadeAt', required
  - `myRecipes.includeFriends` 'yes' | 'no' | 'search' | 'browse', required
  - `recipeDetails.enableWakeLock` boolean, required
  - `recipeDetails.autoExpandNutrition` boolean, required
  - `cookMode.fontSize` '1rem' | '14px' | '16px' | '18px' | '20px' | '22px' | '24px', required
  - `manageLabels.showCreatedAt` boolean, required
  - `measurementConverter.enabledUnits` string[], required
  - `MealPlan.showAddedBy` boolean, required
  - `MealPlan.showAddedOn` boolean, required
  - `MealPlan.startOfWeek` 'monday' | 'sunday', required
  - `MealPlan.viewType` 'calendar' | 'list', required
  - `ShoppingList.sortBy` 'title' | '-title' | 'createdAt' | '-createdAt', required
  - `ShoppingList.showAddedBy` boolean, required
  - `ShoppingList.showAddedOn` boolean, required
  - `ShoppingList.showRecipeTitle` boolean, required
  - `ShoppingList.preferDelete` boolean, required
  - `ShoppingList.groupSimilar` boolean, required
  - `ShoppingList.groupCategories` boolean, required
  - `ShoppingList.ignoreItemTitles` string, required

## Other responses

- `400` — Invalid input data
- `401` — Authorization not provided
- `403` — Insufficient access
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.dev/recipesage/apis/recipesage-api.md) · [All operations](https://skmtc.dev/recipesage/apis/recipesage-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/recipesage/recipesage-api/revisions/08ef517bf108/schema)