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

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

Returns one page of boards, most recently updated first. Each board carries its `tag`; group by that field if you need a tag view. Tabs, widgets and filters are not included.

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

## Request

### Path parameters

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

### Query parameters

- `limit` (integer, optional, default: 50) — Maximum boards to return
- `offset` (integer, optional, default: 0) — Number of boards to skip before this page

### Headers

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

## Response

### 200

Successful Response

- `items` (list of Board, required)
- `total` (integer, required)
- `limit` (integer, required)
- `offset` (integer, required)
- `next_page_uri` (string, optional, nullable)
- `prev_page_uri` (string, optional, nullable)

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

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

### Board

A board's own attributes, without its contents. This is what the list and the write endpoints return. `GET /boards/{board_id}` returns `BoardDetail`, which adds the tabs, their widgets, and the filters.

- `id` (string, required) — Board identifier, used as `{board_id}` in every nested route
- `name` (string, required) — Board display name
- `created_by` (Actor, required) — Actor that created the board
- `created_at` (datetime, required) — Creation time, UTC, RFC 3339
- `updated_by` (Actor, required) — Actor that last changed the board or anything on it
- `updated_at` (datetime, required) — Last change time, UTC, RFC 3339
- `tag` (string, optional, nullable) — The board's grouping tag, or null when untagged

### 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)

### Actor

- `type` (enum, required) — Whether a user or an API key performed the action.
  - Allowed values: `user`, `api_key`
- `id` (string, required) — User identifier for `user`; the key prefix for `api_key`.

### ValidationErrorLocItems

## Examples

**Response**

```json
{
  "items": [
    {
      "id": "0b7f2c9a-5e41-4d2a-9f3b-8c1d6e7a0b52",
      "name": "Campaign Overview",
      "created_by": {
        "type": "api_key",
        "id": "sk_live_a1b2c3"
      },
      "created_at": "2026-09-01T09:15:00Z",
      "updated_by": {
        "type": "user",
        "id": "usr_8f21c4d0"
      },
      "updated_at": "2026-09-12T11:42:08Z",
      "tag": "Weekly reporting"
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0,
  "next_page_uri": null,
  "prev_page_uri": null
}
```

**SDK Code**

```python
import requests

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

querystring = {"limit":"50","offset":"0"}

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

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

print(response.json())
```

```javascript
const url = 'https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards?limit=50&offset=0';
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?limit=50&offset=0"

	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?limit=50&offset=0")

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?limit=50&offset=0")
  .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?limit=50&offset=0', [
  '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?limit=50&offset=0");
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?limit=50&offset=0")! 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()
```