> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# List a member's notification settings
> **Disclaimer:** This beta endpoint is evolving; the API contract may change.
Returns the notification settings an organization member has explicitly chosen. A member who has never changed a setting has none, so an empty list means every notification follows the platform default for their role — it does not mean notifications are off. Settings for notification types the member cannot use are omitted, which depends on their permissions rather than the caller's. Slack is configured for the whole organization and never appears here. A page holds at most `limit` settings (default 100, maximum 250; a larger value is clamped) and the server may return fewer. Every response carries `limit` and `nextCursor`; pass `nextCursor` as the `cursor` query parameter to fetch the next page, repeating until it is null.
Beta
**Disclaimer:** This beta endpoint is evolving; the API contract may change. \
\
Returns the notification settings an organization member has explicitly chosen. A member who has never changed a setting has none, so an empty list means every notification follows the platform default for their role — it does not mean notifications are off. Settings for notification types the member cannot use are omitted, which depends on their permissions rather than the caller's. Slack is configured for the whole organization and never appears here. A page holds at most `limit` settings (default 100, maximum 250; a larger value is clamped) and the server may return fewer. Every response carries `limit` and `nextCursor`; pass `nextCursor` as the `cursor` query parameter to fetch the next page, repeating until it is null.
#### Permission
The API key must have the `control-plane:organization:view-notification-settings` permission.
## OpenAPI
````yaml _specs/cloud-openapi.json GET /v1/organizations/{organizationId}/members/{userId}/notificationSettings
openapi: 3.1.1
info:
title: OpenAPI spec for ClickHouse Cloud
version: '1.0'
contact:
name: ClickHouse Support
url: >-
https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-1415590
email: support@clickhouse.com
servers:
- url: https://api.clickhouse.cloud
security:
- basicAuth: []
tags:
- name: Organization
- name: Notifications
- name: User management
- name: Billing
- name: Role Management
- name: Service
- name: Backup
- name: Snapshot
- name: API keys
- name: Prometheus
- name: ClickPipes
- name: ClickStack
- name: Postgres
- name: UDF
- name: Query API endpoints
- name: Saved queries
paths:
/v1/organizations/{organizationId}/members/{userId}/notificationSettings:
get:
tags:
- Notifications
summary: List a member's notification settings
description: >-
**Disclaimer:** This beta endpoint is evolving; the API contract may
change.
Returns the notification settings an organization
member has explicitly chosen. A member who has never changed a setting
has none, so an empty list means every notification follows the platform
default for their role — it does not mean notifications are off.
Settings for notification types the member cannot use are omitted, which
depends on their permissions rather than the caller's. Slack is
configured for the whole organization and never appears here. A page
holds at most `limit` settings (default 100, maximum 250; a larger value
is clamped) and the server may return fewer. Every response carries
`limit` and `nextCursor`; pass `nextCursor` as the `cursor` query
parameter to fetch the next page, repeating until it is null.
operationId: memberNotificationSettingsGetList
parameters:
- in: path
name: organizationId
description: ID of the organization the member belongs to.
required: true
schema:
type: string
format: uuid
- in: path
name: userId
description: ID of the member whose settings are returned.
required: true
schema:
type: string
format: uuid
- in: query
name: limit
description: Maximum number of results to return.
schema:
type: integer
minimum: 1
maximum: 250
default: 100
- in: query
name: cursor
description: >-
Opaque cursor from a previous response's `nextCursor`, marking where
to resume the list.
schema:
type: string
- in: query
name: type
description: Filter to settings for this notification type.
schema:
type: string
example: service_backup_failed
- in: query
name: resource_id
description: Filter to settings for this resource.
schema:
type: string
- in: query
name: resource_type
description: >-
Filter to settings for resources of this kind. One of 'service',
'organization', 'clickpipe', 'postgres'.
schema:
type: string
example: service
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
status:
type: number
description: HTTP status code.
example: 200
requestId:
type: string
description: Unique id assigned to every request. UUIDv4
format: uuid
result:
type: array
items:
$ref: '#/components/schemas/NotificationSetting'
limit:
type: integer
description: Maximum number of results returned in this page.
nextCursor:
type:
- string
- 'null'
description: >-
Cursor for the next page, to be sent as the `cursor` query
parameter. Null on the last page.
'400':
description: >-
The request cannot be processed due to a client error. Please verify
your request parameters and try again.
content:
application/json:
schema:
type: object
properties:
status:
type: number
description: HTTP status code.
example: 400
error:
type: string
description: Detailed error description.
requestId:
type: string
description: Unique id assigned to every request. UUIDv4
format: uuid
'500':
description: >-
An internal server error has occurred. If this issue persists,
please contact ClickHouse Cloud support for assistance.
content:
application/json:
schema:
type: object
properties:
status:
type: integer
description: HTTP status code.
example: 500
error:
type: string
description: Detailed error description.
requestId:
type: string
description: Unique id assigned to every request. UUIDv4
format: uuid
components:
schemas:
NotificationSetting:
properties:
type:
description: >-
Notification type the setting applies to, named as in [List
notification
types](#tag/Notifications/operation/notificationTypesGetList). New
types are added over time, so treat this as an open set.
type: string
example: service_backup_failed
resourceType:
description: >-
Kind of resource `resourceId` identifies. Current values: service,
organization, clickpipe, postgres. New values may be added over
time. [List notification
types](#tag/Notifications/operation/notificationTypesGetList)
reports the same value for every notification of a given type.
type: string
example: service
resourceId:
description: >-
ID of the resource the setting applies to, of the kind
`resourceType` gives. Settings that apply to the organization
itself, such as billing notifications, carry the organization ID.
type: string
channelType:
description: Delivery channel the setting applies to. One of 'ui', 'email'.
type: string
example: email
effect:
description: >-
Whether the member receives this notification on this channel for
this resource. One of 'enabled', 'disabled'.
type: string
example: disabled
required:
- type
- resourceType
- resourceId
- channelType
- effect
securitySchemes:
basicAuth:
type: http
scheme: basic
description: >-
Use key ID and key secret obtained in ClickHouse Cloud console:
https://clickhouse.com/docs/cloud/manage/openapi
x-permission-scopes: >-
The scope list of a `security` requirement holds ClickHouse Cloud API
key permission ids (for example `control-plane:organization:view`), not
OAuth scopes. OpenAPI has no field for API key permissions, so this is
the closest available place. A key must hold every permission listed on
an operation to call it; an operation with no scopes needs none beyond a
valid key. Every operation declares at most one requirement object,
always for this scheme, so the list is only ever conjunctive —
alternative sets of permissions are never expressed.
````