---
title: "Get user preferences"
method: GET
path: "/v1/user/preferences/{identifyId}"
tags: ["UserPreferences"]
---

# Get user preferences

`GET /v1/user/preferences/{identifyId}`

## Request

- Base URL: `https://app.aptrinsic.com`
- URL: `https://app.aptrinsic.com/v1/user/preferences/{identifyId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/docs/v1/user/preferences/:identifyId/get.ts> (a function with typed inputs; its response is checked against the schema)

If the field is not set - return null.

## Path parameters

- `identifyId` string, required

## Response `200`

Success

- UserPreferences: User preferences
  - `guidedTours` boolean
  - `onboardingBot` boolean
  - `productUpdates` boolean
  - `surveys` boolean
  - `trackUsage` boolean

## Other responses

- `400`: Bad request
- `401`: Unauthorized or bad API Key
- `403`: Access denied
- `404`: User not found by id
- `429`: Rate limit exceeded

---

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