> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.cail.health/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cail.health/_mcp/server. # List notifications GET https://staging.cail.health/v1/notifications Returns the persistent notification log for the operator, ordered by `sentAt` descending by default. Filter by category, delivery status, or read-state. Use the cursor returned in `pagination.cursor` to step through pages. For real-time delivery, subscribe to the SSE stream endpoint instead of polling. Reference: https://docs.cail.health/api-references/api-reference/monitor-performance/list ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: cail-api version: 1.0.0 paths: /v1/notifications: get: operationId: list summary: List notifications description: >- Returns the persistent notification log for the operator, ordered by `sentAt` descending by default. Filter by category, delivery status, or read-state. Use the cursor returned in `pagination.cursor` to step through pages. For real-time delivery, subscribe to the SSE stream endpoint instead of polling. tags: - subpackage_monitorPerformance parameters: - name: cursor in: query description: Opaque cursor returned from a prior call. required: false schema: type: string - name: limit in: query description: Maximum number of results to return. Defaults to 20. required: false schema: type: number format: double - name: sortBy in: query description: Sort field. Defaults to sentAt. required: false schema: type: string - name: sortOrder in: query description: Sort order. Defaults to desc. required: false schema: $ref: '#/components/schemas/V1NotificationsGetParametersSortOrder' - name: category in: query description: Filter by notification category (e.g., `alert.threshold_breach`). required: false schema: type: string - name: status in: query description: Filter by delivery lifecycle status. required: false schema: $ref: '#/components/schemas/V1NotificationsGetParametersStatus' - name: unread in: query description: When true, return only unread notifications. required: false schema: type: boolean - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: A cursor-paginated page of notifications. content: application/json: schema: $ref: '#/components/schemas/ListNotificationsResponse' servers: - url: https://staging.cail.health description: https://staging.cail.health components: schemas: V1NotificationsGetParametersSortOrder: type: string enum: - asc - desc title: V1NotificationsGetParametersSortOrder V1NotificationsGetParametersStatus: type: string enum: - in-progress - completed - failed title: V1NotificationsGetParametersStatus NotificationListItem: type: object properties: id: type: string description: Stable identifier of the notification. category: type: string description: >- Notification category. Stable string codes such as `alert.threshold_breach` or `system.pathway_deprecated`. payload: type: - object - 'null' additionalProperties: description: Any type description: >- Free-form payload carrying category-specific context (alert id, KPI value, threshold). Null when no payload was attached. sentAt: type: string description: ISO 8601 timestamp at which the notification was sent. isRead: type: boolean description: True when the caller has marked the notification as read. required: - id - category - sentAt - isRead title: NotificationListItem ListNotificationsPaginationCursor: type: object properties: {} description: Opaque cursor for the next page. Null when there are no more results. title: ListNotificationsPaginationCursor ListNotificationsPagination: type: object properties: cursor: oneOf: - $ref: '#/components/schemas/ListNotificationsPaginationCursor' - type: 'null' description: >- Opaque cursor for the next page. Null when there are no more results. hasMore: type: boolean description: True when more results exist after this page. limit: type: number format: double description: Echoes the requested page size for client convenience. required: - cursor - hasMore - limit title: ListNotificationsPagination ListNotificationsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NotificationListItem' description: >- Notifications for this page, ordered by sentAt descending by default. pagination: $ref: '#/components/schemas/ListNotificationsPagination' description: Cursor metadata for paging forward. required: - data - pagination title: ListNotificationsResponse securitySchemes: auth0Bearer: type: http scheme: bearer ``` ## Examples **Response** ```json { "data": [ { "id": "e9f8d7c6-b5a4-4392-81b0-c9d8e7f6a5b4", "category": "alert.threshold_breach", "sentAt": "2026-05-13T14:21:00.000Z", "isRead": false, "payload": { "alertRuleId": "1d7d4e29-3b8e-4a01-a4f1-7e2a5b8c1d6e", "kpi": "a_and_e_diversion_rate", "value": 0.42 } }, { "id": "not_02HZX9P3Q5R7S9T1V3W5Y7Z9A1", "category": "system.pathway_deprecated", "sentAt": "2026-05-12T08:00:00.000Z", "isRead": true, "payload": { "planDefinitionId": "a1b2c3d4-e5f6-4789-9abc-def012345678" } } ], "pagination": { "cursor": null, "hasMore": false, "limit": 20 } } ``` **SDK Code** ```python Two recent alerts, one unread import requests url = "https://staging.cail.health/v1/notifications" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Two recent alerts, one unread const url = 'https://staging.cail.health/v1/notifications'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Two recent alerts, one unread package main import ( "fmt" "net/http" "io" ) func main() { url := "https://staging.cail.health/v1/notifications" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Two recent alerts, one unread require 'uri' require 'net/http' url = URI("https://staging.cail.health/v1/notifications") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java Two recent alerts, one unread import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://staging.cail.health/v1/notifications") .header("Authorization", "Bearer ") .asString(); ``` ```php Two recent alerts, one unread request('GET', 'https://staging.cail.health/v1/notifications', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp Two recent alerts, one unread using RestSharp; var client = new RestClient("https://staging.cail.health/v1/notifications"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Two recent alerts, one unread import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://staging.cail.health/v1/notifications")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```