---
title: "List Notification Settings"
method: GET
path: "/notification_settings"
tags: ["Notifications"]
---

# List Notification Settings

`GET /notification_settings`

## Request

- Base URL: `https://dataops.nexla.io/nexla-api`
- URL: `https://dataops.nexla.io/nexla-api/notification_settings`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nexla/apis/nexla-rest-api/docs/notification_settings/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint lists all notification settings in the authenticated user's account.


Notification settings contain the following user settings:
1. Whether the user wants to be notified about a specific event (`status` of a `notification_type` on a `notification_resource_type`)
2. If yes, on what `channel` the user wants to be notified 
3. The configuration of the channel (`notification_channel_setting_id`)
4. Configuration parameters affect when the notification should be fired. This is usually left empty to use platform defaults, but it is relevant when users want to override the default settings of some notifications, such as `Source Data Delayed`

## Query parameters

- `event_type` 'SHARE' | 'CREATE' | 'DELETE' | 'UPDATE' | 'ACTIVATE' | 'PAUSE' | 'METRICS' | 'RESETPASS' | 'ERROR_AGGREGATED' | 'ERROR' | 'MONITOR' | 'WRITE' | 'EMPTY_DATA' | 'READ_START' | 'READ_DONE' | 'WRITE_START' | 'WRITE_DONE'
- `resource_type` 'ORG' | 'USER' | 'DATA_FLOW' | 'CUSTOM_DATA_FLOW' | 'SOURCE' | 'DATASET' | 'SINK'
- `status` 'PAUSED' | 'ACTIVE': Whether or not the user should be notified about this event for this resource on the selected channel.

## Response `200`

Success

- NotificationSetting[]
  - `id` integer
  - `org_id` integer
  - `owner_id` integer
  - `channel` 'APP' | 'EMAIL' | 'SMS' | 'SLACK' | 'WEBHOOKS'
  - `notification_resource_type` 'ORG' | 'USER' | 'DATA_FLOW' | 'CUSTOM_DATA_FLOW' | 'SOURCE' | 'DATASET' | 'SINK'
  - `resource_id` integer
  - `config` object
  - `priority` integer
  - `status` 'PAUSED' | 'ACTIVE': Whether or not the user should be notified about this event for this resource on the selected channel.
  - `notification_type_id` integer
  - `name` string
  - `description` string
  - `code` integer
  - `category` string
  - `event_type` 'SHARE' | 'CREATE' | 'DELETE' | 'UPDATE' | 'ACTIVATE' | 'PAUSE' | 'METRICS' | 'RESETPASS' | 'ERROR_AGGREGATED' | 'ERROR' | 'MONITOR' | 'WRITE' | 'EMPTY_DATA' | 'READ_START' | 'READ_DONE' | 'WRITE_START' | 'WRITE_DONE'
  - `resource_type` 'ORG' | 'USER' | 'DATA_FLOW' | 'CUSTOM_DATA_FLOW' | 'SOURCE' | 'DATASET' | 'SINK'

## Other responses

- `400`: Bad Request
- `403`: Forbidden

---

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