Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

List a member's notification settings

GET/v1/organizations/{organizationId}/members/{userId}/notificationSettings
API playground

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

Path parameters

  • organizationIdstringrequired

    ID of the organization the member belongs to.

    format: uuid
  • userIdstringrequired

    ID of the member whose settings are returned.

    format: uuid

Query parameters

  • limitoptionalinteger

    Maximum number of results to return.

    maximum: 250, minimum: 1
    Default: 100
  • cursoroptionalstring

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

  • typeoptionalstring

    Filter to settings for this notification type.

    Example: "service_backup_failed"
  • resource_idoptionalstring

    Filter to settings for this resource.

  • resource_typeoptionalstring

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

    Example: "service"

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalarray ofobject
    5 properties
    • typestringrequired

      Notification type the setting applies to, named as in List notification types. New types are added over time, so treat this as an open set.

      Example: "service_backup_failed"
    • resourceTypestringrequired

      Kind of resource resourceId identifies. Current values: service, organization, clickpipe, postgres. New values may be added over time. List notification types reports the same value for every notification of a given type.

      Example: "service"
    • resourceIdstringrequired

      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.

    • channelTypestringrequired

      Delivery channel the setting applies to. One of 'ui', 'email'.

      Example: "email"
    • effectstringrequired

      Whether the member receives this notification on this channel for this resource. One of 'enabled', 'disabled'.

      Example: "disabled"
  • limitoptionalinteger

    Maximum number of results returned in this page.

  • nextCursoroptionalstring | null

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