Sign in
User Notifications (notifications/v1)

List of User Notifications

Early Access Request Access To User Notifications API v1

Retrieve a sorted, filtered, paginated list of all user notifications.

get/notifications/v1/user-notifications

Query parameters

readboolean

Filter for whether this value is true or false.

Filter the results where read is true or false.

severitystring[]

Filter a collection by a string search for one or more values

Filter notifications by severity. Pass the parameter multiple times to match any of the given values (?severity=CRITICAL&severity=WARN). A notification matches if its severity equals any of the listed values.

includestring

Filter a collection by a string search

Comma-separated list of optional fields to populate in the response items. Allowed values: integrations, recommended_actions. By default these fields are omitted from list responses to keep collection payloads slim; set this parameter to opt in. This is a partial-response selector, not a value filter.

resource.typestring[]

Filter a collection by a string search for one or more values

Filter notifications by the Confluent Cloud resource type they relate to. Pass the parameter multiple times to match any of the given values (?resource.type=CLUSTER&resource.type=CONNECTOR). A notification matches if its resource.type equals any of the listed values.

resource.crnstring[]

Filter a collection by a string search for one or more values

Filter notifications by the CRN of the Confluent Cloud resource they relate to. Pass the parameter multiple times to match any of the given CRNs; a notification matches if its resource.crn equals any of the listed values.

searchstring

Filter a collection by a string search

Free-text partial-match search across the embedded notification type's display_name and description.

time_rangestring

Filter a collection by a string search

Filter notifications by a preset time window relative to now. Allowed values: PAST_24H (last 24 hours), PAST_7D (last 7 days), PAST_30D (last 30 days).

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

sortstring[]

The list of fields and directions that are used to sort the collection.

Response

User Notification.

api_version'notifications/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'UserNotificationList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/notifications/v1/user-notifications",
    "last": "https://api.confluent.cloud/notifications/v1/user-notifications?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/notifications/v1/user-notifications?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/notifications/v1/user-notifications?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/notifications/v1/user-notifications/un-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/user-notification=un-12345",
        "created_at": "2006-01-02T15:04:05-07:00",
        "updated_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00"
      },
      "read_at": "2026-01-31T11:00:00Z",
      "severity": "CRITICAL",
      "received_at": "2026-01-31T10:35:00Z",
      "resource": {
        "type": "CLUSTER",
        "crn": "crn://confluent.cloud/organization=org-abc/environment=env-xyz/kafka-cluster=lkc-ds23ad",
        "display_name": "prod-kafka-cluster"
      },
      "actions": [
        {
          "identifier": "manage_cluster_settings",
          "url": "https://confluent.cloud/environments/env-xyz/clusters/lkc-ds23ad/settings",
          "role": "PRIMARY"
        }
      ],
      "notification_type": {
        "id": "dlz-f3a90de",
        "metadata": {
          "self": "https://api.confluent.cloud/notifications/v1/notification-types/nt-12345",
          "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/notification-type=nt-12345",
          "created_at": "2006-01-02T15:04:05-07:00",
          "updated_at": "2006-01-02T15:04:05-07:00",
          "deleted_at": "2006-01-02T15:04:05-07:00"
        },
        "display_name": "Cluster Shrink",
        "category": "BILLING_LICENSING",
        "description": "Cluster shrink operation is completed",
        "subscription_priority": "REQUIRED",
        "severity": "INFO",
        "resource_type": "CONNECTOR"
      },
      "integrations": [
        {
          "id": "dlz-f3a90de",
          "metadata": {
            "self": "https://api.confluent.cloud/notifications/v1/integrations/i-12345",
            "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/integration=i-12345",
            "created_at": "2006-01-02T15:04:05-07:00",
            "updated_at": "2006-01-02T15:04:05-07:00",
            "deleted_at": "2006-01-02T15:04:05-07:00"
          },
          "display_name": "Slack integration",
          "description": "A Slack channel integration",
          "target": {
            "kind": "Slack",
            "webhook_url": "https://hooks.slack.com/services/{id}/{id}/{id}"
          }
        }
      ],
      "recommended_actions": {
        "version": 1,
        "content": "Restart the cluster from the Confluent Cloud console."
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.