Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

List of organization notifications

GET/v1/organizations/{organizationId}/notifications
API playground

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 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.

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization the notifications belong to.

    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.

  • severityoptionalstring

    Filter to notifications of this severity: 'info', 'warning', 'critical'.

    Example: "warning"
  • typeoptionalstring

    Filter to notifications of this type. New types are added over time; the notification types endpoint lists the ones this organization can receive.

  • resource_idoptionalstring

    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.

  • resource_typeoptionalstring

    Filter to notifications about resources of this kind. One of 'service', 'organization', 'clickpipe', 'postgres'.

    Example: "service"
  • from_dateoptionalstring

    Return notifications created at or after this time. An RFC 3339 timestamp, not a bare date.

    format: date-time
    Example: "2026-10-01T00:00:00Z"
  • to_dateoptionalstring

    Return notifications created at or before this time. An RFC 3339 timestamp, not a bare date.

    format: date-time
    Example: "2026-10-08T00:00:00Z"

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalarray ofobject
    9 properties
    • idstringrequired

      Unique notification ID.

      format: uuid
      Example: "1b7e0a94-2d0f-4c3a-8f1e-6c9b2d5a4e7f"
    • typestringrequired

      Notification type. New types are added over time, so treat this as an open set.

      Example: "service_backup_failed"
    • severitystringrequired

      Severity of the notification. One of 'info', 'warning', 'critical'.

      Example: "warning"
    • resourceTypestringrequired

      Kind of resource the notification is about. One of 'service', 'organization', 'clickpipe', 'postgres'.

      Example: "service"
    • resourceIdstringrequired

      ID of the resource the notification is about.

    • createdAtstringrequired

      When the notification was created. ISO-8601.

      format: date-time
      Example: "2026-10-07T09:30:00Z"
    • titlestringrequired

      Short human-readable summary.

      Example: "Backup failed for analytics-prod"
    • descriptionstringrequired

      Human-readable body as plain text, with any links written as "label (url)".

      Example: "A scheduled backup for analytics-prod did not complete. Review the backup settings (https://console.clickhouse.cloud/services/abc/backups)."
    • resourceNameoptionalstring

      Name the resource had when the notification was created. Absent for most notification types; use resourceId to identify the resource.

  • 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.