> ## 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 of organization notifications
> **Disclaimer:** This beta endpoint is evolving; the API contract may change.
Returns notifications for the organization, most recent first. Only notifications about resources the caller can access are returned, so two keys in the same organization can see different results. The [notification types endpoint](/products/cloud/api-reference/notifications/notification-types-get-list) lists the types this organization can receive, so it shows what to expect here. Notifications are retained for 180 days. A page holds at most `limit` notifications (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 notifications for the organization, most recent first. Only notifications about resources the caller can access are returned, so two keys in the same organization can see different results. The [notification types endpoint](/docs/products/cloud/api-reference/notifications/notification-types-get-list) lists the types this organization can receive, so it shows what to expect here. Notifications are retained for 180 days. A page holds at most `limit` notifications (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.
## OpenAPI
````yaml _specs/cloud-openapi.json GET /v1/organizations/{organizationId}/notifications
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-1255061
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}/notifications:
get:
tags:
- Notifications
summary: List of organization notifications
description: >-
**Disclaimer:** This beta endpoint is evolving; the API contract may
change.
Returns notifications for the organization, most
recent first. Only notifications about resources the caller can access
are returned, so two keys in the same organization can see different
results. The [notification types
endpoint](#tag/Notifications/operation/notificationTypesGetList) lists
the types this organization can receive, so it shows what to expect
here. Notifications are retained for 180 days. A page holds at most
`limit` notifications (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: notificationGetList
parameters:
- in: path
name: organizationId
description: ID of the organization the notifications belong to.
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: severity
description: >-
Filter to notifications of this severity: 'info', 'warning',
'critical'.
schema:
type: string
example: warning
- in: query
name: type
description: >-
Filter to notifications of this type. New types are added over time;
the [notification types
endpoint](#tag/Notifications/operation/notificationTypesGetList)
lists the ones this organization can receive.
schema:
type: string
- in: query
name: resource_id
description: >-
Filter to notifications about this resource. A service also matches
the notifications of its ClickPipes; pass `resource_type` to narrow
to one kind of resource.
schema:
type: string
- in: query
name: resource_type
description: >-
Filter to notifications about resources of this kind. One of
'service', 'organization', 'clickpipe', 'postgres'.
schema:
type: string
example: service
- in: query
name: from_date
description: >-
Return notifications created at or after this time. An RFC 3339
timestamp, not a bare date.
schema:
type: string
format: date-time
example: '2026-10-01T00:00:00Z'
- in: query
name: to_date
description: >-
Return notifications created at or before this time. An RFC 3339
timestamp, not a bare date.
schema:
type: string
format: date-time
example: '2026-10-08T00:00:00Z'
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/Notification'
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:
Notification:
properties:
id:
description: Unique notification ID.
type: string
format: uuid
example: 1b7e0a94-2d0f-4c3a-8f1e-6c9b2d5a4e7f
type:
description: >-
Notification type. New types are added over time, so treat this as
an open set.
type: string
example: service_backup_failed
severity:
description: Severity of the notification. One of 'info', 'warning', 'critical'.
type: string
example: warning
resourceType:
description: >-
Kind of resource the notification is about. One of 'service',
'organization', 'clickpipe', 'postgres'.
type: string
example: service
resourceId:
description: ID of the resource the notification is about.
type: string
resourceName:
description: >-
Name the resource had when the notification was created. Absent for
most notification types; use `resourceId` to identify the resource.
type: string
createdAt:
description: When the notification was created. ISO-8601.
type: string
format: date-time
example: '2026-10-07T09:30:00Z'
title:
description: Short human-readable summary.
type: string
example: Backup failed for analytics-prod
description:
description: >-
Human-readable body as plain text, with any links written as "label
(url)".
type: string
example: >-
A scheduled backup for analytics-prod did not complete. Review the
backup settings
(https://console.clickhouse.cloud/services/abc/backups).
required:
- id
- type
- severity
- resourceType
- resourceId
- createdAt
- title
- description
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.
````