---
title: "Get preferences for the authenticated user"
method: GET
path: "/api/v3/user/preferences"
tags: ["Users"]
---

# Get preferences for the authenticated user

`GET /api/v3/user/preferences`

## Request

- Base URL: `https://codemagic.io`
- URL: `https://codemagic.io/api/v3/user/preferences`
- Auth: API key in header `x-auth-token`
- TypeScript: <https://skmtc.dev/codemagic/apis/codemagic-api/docs/api/v3/user/preferences/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

Request fulfilled, document follows

- PreferencesSchemaNoPagination
  - `data` PreferencesSchema, required
    - `pinned_accounts` PinnedAccountSchema[], required
      - `team` string, required: Allowed values: `personal` or team ID, see [/user/teams](#/operations/UserTeamsGetTeams)
      - `view` 'full' | 'compact', required
    - `theme` 'light' | 'dark' | 'system', required
    - `selected_team` string, nullable, required
    - `expanded_nav` boolean, nullable, required
    - `eligible_for_onboarding_flow` boolean, required: Whether the onboarding flow is shown to the user.
    - `pinned_apps` PinnedAppsSchema[], required
      - `team_id` string, required
      - `app_ids` string[], required

## Other responses

- `401`: Authentication is missing or invalid
- `429`: The rate limit has been exceeded

---

[API](https://skmtc.dev/codemagic/apis/codemagic-api.md) - [All operations](https://skmtc.dev/codemagic/apis/codemagic-api/llms.txt) - [OpenAPI document](https://skmtc.dev/codemagic/apis/codemagic-api/revisions/be09630f65e2?raw)