## Get notification settings

`GET /v1/notifications/settings`

Returns the channels through which an employee receives notifications about events in each module of the Bitrix24 account.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|----------|
| `userId` (query) | number | no | ID of the employee whose settings to read — a positive integer. List: [`GET /v1/users`](/docs/entities/users/list). If omitted, the settings of the employee on whose behalf the call is made are returned. Another employee's settings are available only to a Bitrix24 administrator |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/notifications/settings" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/notifications/settings" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/notifications/settings', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
const im = data.find((m) => m.id === 'im')
console.log(im?.notices.map((n) => `${n.id}: site=${n.site} mail=${n.mail} push=${n.push}`))
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/notifications/settings', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
console.log('Modules:', data.length)
```

## Response fields

| Field | Type | Description |
|------|-----|----------|
| `success` | boolean | Always `true` on success |
| `data` | array | Modules of the Bitrix24 account with configurable notifications |
| `data[].id` | string | Module identifier. Matches `notifyModule` of a notification in the [feed](/docs/notifications/list). The same value is passed in the `module` field when [changing a setting](/docs/notifications/settings/update) and in [notification group conditions](/docs/notifications/groups/conditions-create) |
| `data[].label` | string | Module name |
| `data[].notices` | array | Module events |
| `data[].notices[].id` | string | Event identifier. Matches `notifyEvent` of a notification in the feed |
| `data[].notices[].label` | string | Event name |
| `data[].notices[].site` | boolean | The "Web version and desktop app" channel. `true` — notifications about the event arrive through this channel |
| `data[].notices[].mail` | boolean | The "Email" channel |
| `data[].notices[].push` | boolean | The "Mobile devices (push notifications)" channel |
| `data[].notices[].disabled` | array | Event channels that cannot be changed: `site`, `mail`, `push`. The value of such a channel is set by the Bitrix24 account: `true` or `false` |

## Response example

Two modules are shown, each with some of its events. The set of modules and events depends on the Bitrix24 account.

HTTP 200:

```json
{
  "success": true,
  "data": [
    {
      "id": "im",
      "label": "Chats and calls",
      "notices": [
        {
          "id": "message",
          "label": "Direct chat messages",
          "site": true,
          "mail": false,
          "push": false,
          "disabled": ["site"]
        },
        {
          "id": "like",
          "label": "Reactions to your messages",
          "site": false,
          "mail": false,
          "push": false,
          "disabled": ["push"]
        }
      ]
    },
    {
      "id": "bizproc",
      "label": "Workflows",
      "notices": [
        {
          "id": "activity",
          "label": "Workflow notifications",
          "site": true,
          "mail": false,
          "push": false,
          "disabled": []
        },
        {
          "id": "wi_locked",
          "label": "Workflow aborted",
          "site": true,
          "mail": false,
          "push": false,
          "disabled": ["push"]
        }
      ]
    }
  ]
}
```

## Error response example

400 — `userId` is not a positive integer:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "The query parameter `userId` must be a positive integer."
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | `userId` is not a positive integer. Checked before the Bitrix24 call |
| 400 | `INVALID_PARAMS` | `userId` was passed more than once or with brackets, for example `userId[]=5` |
| 400 | `INVALID_PARAMS` | A query parameter other than `userId` was passed. The accepted parameters are listed in `message` |
| 401 | `TOKEN_MISSING` | The key has no configured tokens |
| 403 | `SCOPE_DENIED` | The key lacks the `im` scope |
| 422 | `BITRIX_ERROR` | `userId` points to another employee, and the employee on whose behalf the call is made has no Bitrix24 administrator rights. The portal code `SETTINGS_ACCESS_DENIED` is in the `error.b24Code` field |
| 502 | `ME_ALIAS_RESOLUTION_FAILED` | `userId` was not passed, and the employee on whose behalf the call is made could not be determined. The settings were not requested |

Full list of common API errors — [Errors](/docs/errors).

## Known specifics

- For an administrator, a non-existent `userId` does not cause an error: the response contains the default settings. A successful response does not confirm that an employee with this ID exists in the Bitrix24 account. To check the employee, use [`GET /v1/users/:id`](/docs/entities/users/get).

## See also

- [Change a notification setting](/docs/notifications/settings/update)
- [Switch the notification settings mode](/docs/notifications/settings/scheme)
- [Notification settings](/docs/notifications/settings)
- [Notification groups](/docs/notifications/groups)
- [Notification feed](/docs/notifications/list)