> For clean Markdown of any page, append `.md` to the page URL.
> For a complete documentation index, see https://docs.sarvam.ai/llms.txt.
> For full documentation content in one file, see https://docs.sarvam.ai/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.sarvam.ai/_mcp/server.

# List notification rules

GET https://apps.sarvam.ai/api/analytics/v1/{org_id}/{workspace_id}/boards/{board_id}/notifications

Returns the board's rules, optionally narrowed to one widget or to enabled rules only.

Reference: https://docs.sarvam.ai/api-reference/boards/notifications/list

## Request

### Path parameters

- `org_id` (string, required) — Organization ID
- `workspace_id` (string, required) — Workspace ID
- `board_id` (string, required)

### Query parameters

- `widget_id` (string, optional, nullable) — Return only rules delivering this widget
- `enabled` (boolean, optional, nullable) — Return only enabled (true) or only paused (false) rules

### Headers

- `X-API-Key` (string, required) — Your workspace API key.

## Response

### 200

Successful Response

- `notifications` (list of NotificationRule, required) — The board's notification rules, most recently created first

## Errors

### 401 Unauthorized Error

Missing or invalid credentials

- `error` (ErrorBody, required) — Details of the error that occurred.

### 403 Forbidden Error

Credentials are not scoped to this org and workspace

- `error` (ErrorBody, required) — Details of the error that occurred.

### 404 Not Found Error

No such resource in this workspace

- `error` (ErrorBody, required) — Details of the error that occurred.

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

### 429 Too Many Requests Error

Rate limit exceeded. Honour the `Retry-After` response header before retrying.

- `error` (ErrorBody, required) — Details of the error that occurred.

### 500 Internal Server Error

Unexpected server error

- `error` (ErrorBody, required) — Details of the error that occurred.

## Types

### NotificationRule

- `rule_id` (string, required) — Rule identifier, used as `{rule_id}` in nested routes
- `widget_id` (string, required) — Widget whose result this rule delivers
- `cron` (string, required) — Five-field cron expression, evaluated in Asia/Kolkata
- `enabled` (boolean, required) — False while the schedule is paused
- `created_at` (datetime, required) — Creation time, UTC, RFC 3339
- `updated_at` (datetime, required) — Last change time, UTC, RFC 3339
- `name` (string, optional, nullable) — Label for the rule, or null when unnamed
- `next_run_at` (datetime, optional, nullable) — Next scheduled delivery, UTC. Null when the rule is disabled.
- `email_recipients` (list of string, optional, nullable) — Configured email recipients
- `slack_channel_name` (string, optional, nullable) — Slack destination label, when one is configured
- `slack_configured` (boolean, optional, default: false) — True when a Slack webhook is set. The URL itself is never returned.

### ErrorBody

Details of the error that occurred.

- `code` (string, required) — A service-specific error code.
- `message` (string, required) — A human-readable description of the error.

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### ValidationErrorLocItems

## Examples

**Response**

```json
{
  "notifications": [
    {
      "rule_id": "9e3f61d0-4a28-4c75-b13e-6d8025af7c94",
      "widget_id": "a4c9e0f7-31b8-4d6a-9e25-7f0b3c81d46e",
      "cron": "30 3 * * *",
      "enabled": true,
      "created_at": "2026-09-05T07:40:12Z",
      "updated_at": "2026-09-05T07:40:12Z",
      "name": "Daily connectivity to ops",
      "next_run_at": "2026-09-16T22:00:00Z",
      "email_recipients": [
        "ops@example.com"
      ],
      "slack_channel_name": "#agent-ops",
      "slack_configured": true
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/notifications"

headers = {"X-API-Key": "<your-api-key>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/notifications';
const options = {method: 'GET', headers: {'X-API-Key': '<your-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/notifications"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<your-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/notifications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<your-api-key>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/notifications")
  .header("X-API-Key", "<your-api-key>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/notifications', [
  'headers' => [
    'X-API-Key' => '<your-api-key>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/notifications");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Key", "<your-api-key>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-Key": "<your-api-key>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/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()
```