---
title: "Get user settings"
method: GET
path: "/v2/users/me/settings"
tags: ["Users"]
---

# Get user settings

`GET /v2/users/me/settings`

## Request

- Base URL: `https://api.streak.com/api`
- URL: `https://api.streak.com/api/v2/users/me/settings`
- Auth: HTTP bearer

Returns the authenticated user's settings.

## Response `200`

OK

- UserSettings: The current user's settings. Values are effective values: settings the user never changed report their defaults.
  - `streakIt` boolean: Show the Add To Box button on Gmail thread rows.
  - `listIndicatorType` ListIndicator[], required: Information shown in the box indicator on Gmail thread rows.
  - `pixelTrackingDefaultOn` boolean: Turn on email tracking by default for new emails.
  - `snippetAutoComplete` boolean: Autocomplete snippets in compose.
  - `pipelineShared` NotificationChannel[], required: Notify when a pipeline is shared with the user.
  - `followedBox` boolean: Notify about changes to boxes the user follows or is assigned to. When false, all followedBox* notifications are off.
  - `followedBoxStageChange` NotificationChannel[], required: Notify when a followed box changes stage. Ignored while followedBox is false.
  - `followedBoxNewComment` NotificationChannel[], required: Notify about new comments on followed boxes. Ignored while followedBox is false.
  - `followedAssignedToMe` NotificationChannel[], required: Notify when a box or task is assigned to the user. Ignored while followedBox is false.
  - `followedAssignedToSelf` NotificationChannel[], required: Notify when the user assigns a box or task to themselves. Ignored while followedBox is false.
  - `followedBoxDataChange` NotificationChannel[], required: Notify about data changes on followed boxes. Ignored while followedBox is false.
  - `anyBox` boolean: Notify about changes to all other boxes the user can access. When false, all anyBox* notifications are off.
  - `anyBoxStageChange` NotificationChannel[], required: Notify when any box changes stage. Ignored while anyBox is false.
  - `anyBoxNewComment` NotificationChannel[], required: Notify about new comments on any box. Ignored while anyBox is false.
  - `anyBoxDataChange` NotificationChannel[], required: Notify about data changes on any box. Ignored while anyBox is false.
  - `newBox` NotificationChannel[], required: Notify when a new box is created.
  - `tasks` NotificationChannel[], required: Notify when tasks are due.
  - `tasksCompleted` NotificationChannel[], required: Notify when others complete tasks the user created.
  - `meetings` NotificationChannel[], required: Notify about new call logs and meeting notes.
  - `importJobStatus` NotificationChannel[], required: Notify when a pipeline import completes.
  - `firstTrackedThreadRead` NotificationChannel[], required: Notify the first time a tracked email is read.
  - `firstTrackedThreadClick` NotificationChannel[], required: Notify the first time a tracked email is clicked.

## Changes

- **2026-10-16** `1c3a5ef8b9ea`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/streakyc/apis/streak/changes/v2/users/me/settings/get.md)

---

[API](https://skmtc.dev/streakyc/apis/streak.md) - [All operations](https://skmtc.dev/streakyc/apis/streak/llms.txt) - [OpenAPI document](https://skmtc.dev/streakyc/apis/streak/revisions/3648671fd1cf?raw)