---
title: "Fetch user preferences"
method: GET
path: "/preferences"
tags: ["Preferences"]
---

# Fetch user preferences

`GET /preferences`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/preferences`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

This endpoint is used to fetch user preferences.

## Response `200`

Preferences data

- PreferencesSchema
  - `GLOBAL` GlobalSchema, required
    - `SELF_SERVE` SelfServeSchema
      - `onboarding_state` string, required: Onboarding State
    - `ONBOARDING` OnboardingSchema
      - `DATAFLOW_SETTINGS` boolean: Dataflow Settings
    - `WORKFLOWS` WorkflowsSchema
      - `pinned_ids` string[]
      - `groups` object[]
      - `group_map` object
    - `DASHBOARDS` DashboardsSchema
      - `pinned_ids` string[]
    - `FIRST_TIME_ON_DL` boolean, nullable: First Time On Data Landing
    - `PREFERENCES` object, nullable: Data landing preferences (dataset/view scoped keys)

## Other responses

- `400`: Bad Request
- `401`: Authorization error

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/5dfd1c296ded?raw)
