Skip to main content
GET
List a member's notification settings
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.

Authorizations

Authorization
string
header
required

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path Parameters

organizationId
string<uuid>
required

ID of the organization the member belongs to.

userId
string<uuid>
required

ID of the member whose settings are returned.

Query Parameters

limit
integer
default:100

Maximum number of results to return.

Required range: 1 <= x <= 250
cursor
string

Opaque cursor from a previous response's nextCursor, marking where to resume the list.

type
string

Filter to settings for this notification type.

Example:

"service_backup_failed"

resource_id
string

Filter to settings for this resource.

resource_type
string

Filter to settings for resources of this kind. One of 'service', 'organization', 'clickpipe', 'postgres'.

Example:

"service"

Response

Successful response

status
number

HTTP status code.

Example:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object[]
limit
integer

Maximum number of results returned in this page.

nextCursor
string | null

Cursor for the next page, to be sent as the cursor query parameter. Null on the last page.