---
title: "Get pulse settings"
method: GET
path: "/v2/employee-sentiment/settings"
tags: ["Employee Sentiment"]
---

# Get pulse settings

`GET /v2/employee-sentiment/settings`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api`
- URL: `https://your-subdomain.deputy.deputy.com/api/v2/employee-sentiment/settings`
- Auth: API key in header `OAuth`

Get pulse settings.

## Response `200`

A successful response.

- EmployeeSentimentGetSettingsResponse
  - `success` boolean
  - `data` ModelPulseSettings
    - `tenantId` string
    - `isShiftPulseFullVersion` boolean
    - `isShiftPulseEnabled` boolean
    - `emojis` ModelPulseSettingsEmoji[]
      - `icon` string
      - `label` string
      - `score` 'UNKNOWN_SCORE' | 'STRESSED' | 'FRUSTRATED' | 'OKAY' | 'GOOD' | 'HAPPY'
      - `order` integer
    - `customQuestions` ModelQuestion[]
      - `id` string
      - `type` 'UNKNOWN_QUESTION_TYPE' | 'SHORT' | 'YES_NO' | 'MULTIPLE'
      - `question` string
      - `description` string
      - `options` string[]
      - `isRequired` boolean
      - `order` integer
      - `isSelected` boolean
      - `isCustom` boolean
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
      - `responses` ModelQuestionResponse[]
        - `answer` string
        - `comment` string
    - `pulseFrequency` 'PULSE_FREQUENCY_UNKNOWN' | 'PULSE_FREQUENCY_EVERY_SHIFT' | 'PULSE_FREQUENCY_DAILY' | 'PULSE_FREQUENCY_WEEKLY' | 'PULSE_FREQUENCY_FORTNIGHTLY' | 'PULSE_FREQUENCY_MONTHLY'
    - `roleIds` integer[]
    - `locationIds` integer[]
    - `areaIds` integer[]
    - `createdAt` string, date-time
    - `modifiedAt` string, date-time

---

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