---
title: "Get User Settings"
method: GET
path: "/api/auth/users/current/settings"
tags: ["UsersService"]
---

# Get User Settings

`GET /api/auth/users/current/settings`

Get basic settings & onboarding info for a user, like contact preferences and product tour state.

## Query parameters

- `userId` string

## Response `200`

OK

- ProtosAuthV1GetUserSettingsResponse
  - `settings` ProtosAuthV1UserSettings
    - `primaryEmail` string — the user's currently selected email address
    - `hasAcceptedToc` boolean — if the user has accepted the terms of service
    - `subscribe` boolean — if the user is subscribed to emails
    - `contactAboutExperiments` boolean — if the user would like to be contacted about product experiments
    - `availableEmails` ProtosAuthV1UserEmail[] — other emails that the user has
      - `email` string
      - `primary` boolean
      - `verified` boolean
    - `profilePhotoUrl` string — the user's profile photo url
    - `hasCompletedFindingsTour` boolean — if the user has completed the findings product tour, deprecated (see findings_tour_state)
    - `hasCompletedSupplyChainTour` boolean — if the user has completed the supply chain product tour, deprecated (see supply_chain_tour_state)
    - `findingsTourState` 'TOUR_STATE_INCOMPLETE' | 'TOUR_STATE_COMPLETE' | 'TOUR_STATE_SKIPPED', enum — the completion state of the findings product tour | value | description | |-------|---------------| | TOUR_STATE_INCOMPLETE | | | TOUR_STATE_COMPLETE | | | TOUR_STATE_SKIPPED | |
    - `supplyChainTourState` 'TOUR_STATE_INCOMPLETE' | 'TOUR_STATE_COMPLETE' | 'TOUR_STATE_SKIPPED', enum — the completion state of the supply chain product tour | value | description | |-------|---------------| | TOUR_STATE_INCOMPLETE | | | TOUR_STATE_COMPLETE | | | TOUR_STATE_SKIPPED | |
    - `supplyChainFindingsTourState` 'TOUR_STATE_INCOMPLETE' | 'TOUR_STATE_COMPLETE' | 'TOUR_STATE_SKIPPED', enum — the completion state of the supply chain product tour (using the new findings UI) | value | description | |-------|---------------| | TOUR_STATE_INCOMPLETE | | | TOUR_STATE_COMPLETE | | | TOUR_STATE_SKIPPED | |
    - `tourStates` ProtosAuthV1TourStateEntry[] — scalable structure for tour states
      - `id` 'TOUR_ID_AI_SCAN' | 'TOUR_ID_AUTOFIX_INTRO' | 'TOUR_ID_SCA_AUTOFIX_INTRO' | 'TOUR_ID_MULTIMODAL_BANNER' | 'TOUR_ID_COMBINED_FINDINGS', enum — | value | description | |-------|---------------| | TOUR_ID_AI_SCAN | | | TOUR_ID_AUTOFIX_INTRO | | | TOUR_ID_SCA_AUTOFIX_INTRO | | | TOUR_ID_MULTIMODAL_BANNER | | | TOUR_ID_COMBINED_FINDINGS | |
      - `state` 'TOUR_STATE_INCOMPLETE' | 'TOUR_STATE_COMPLETE' | 'TOUR_STATE_SKIPPED', enum — | value | description | |-------|---------------| | TOUR_STATE_INCOMPLETE | | | TOUR_STATE_COMPLETE | | | TOUR_STATE_SKIPPED | |

---

[API](https://skmtc.net/semgrep/apis/semgrep-web-app.md) · [All operations](https://skmtc.net/semgrep/apis/semgrep-web-app/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/semgrep/semgrep-web-app/revisions/6483eeecd582/schema)
