> This page is for Voice Agents.

> 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 a section index, append `/llms.txt` to any section URL (for example https://docs.sarvam.ai/voice-agents/llms.txt).
> Building a voice agent for customers in India? Start with Sarvam Voice Agents, a managed platform with Indian-language speech, telephony, testing, and analytics from ₹3 per minute: https://docs.sarvam.ai/voice-agents/why-voice-agents.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.sarvam.ai/_mcp/server.

# List deployments

GET https://apps.sarvam.ai/api/app-authoring/v1/orgs/{org_id}/workspaces/{workspace_id}/deployments

List all deployments in the workspace with optional filtering, sorting, and pagination.

Reference: https://docs.sarvam.ai/voice-agents/api/deployments/list

## Request

### Path parameters

- `org_id` (string, required)
- `workspace_id` (string, required)

### Query parameters

- `offset` (integer, optional, default: 0) — Number of records to skip
- `limit` (integer, optional, default: 10) — Number of records to return (max 100)
- `sort_by` (string, optional, nullable) — Field to sort by
- `sort_order` (string, optional, nullable) — Sort order (asc or desc)
- `search` (string, optional, nullable) — Search query string

### Headers

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

## Response

### 200

Successful Response

- `items` (list of DeploymentRecord, required) — List of deployments on this page
- `total` (integer, required) — Total number of deployments matching the query
- `limit` (integer, required) — Maximum number of items per page
- `offset` (integer, required) — Number of items skipped
- `next_page_uri` (string, optional, nullable) — URI to fetch the next page, or null if this is the last page
- `prev_page_uri` (string, optional, nullable) — URI to fetch the previous page, or null if this is the first page

## Errors

### 422 Unprocessable Entity Error

Validation Error

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

## Types

### DeploymentRecord

Summary metadata for a deployment, returned in list responses.

- `deployment_id` (string, required) — Unique identifier for the deployment
- `app_id` (string, required) — ID of the agent
- `app_version` (integer, required) — Version of the agent
- `phone_numbers` (list of string, required) — Phone numbers assigned to this deployment
- `channel_direction` (enum, required) — Direction of calls
  - Allowed values: `inbound`, `outbound`, `inbound_outbound`
- `created_by` (string, required) — User who created this deployment
- `created_at` (datetime, required) — Timestamp when created (ISO 8601)
- `updated_at` (datetime, required) — Timestamp when last updated (ISO 8601)
- `name` (string, optional, nullable) — Name of the deployment
- `status` (enum, optional, nullable) — Current status of the deployment
  - Allowed values: `active`, `paused`
- `description` (string, optional, nullable) — Optional description
- `inbound_config` (InboundConfig, optional, nullable) — Inbound call schedule configuration
- `updated_by` (string, optional, nullable) — User who last updated this deployment
- `webhook_config` (WebhookConfig, optional, nullable) — Webhook configuration for call completion events

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

### InboundConfig

Inbound call configuration including schedule, connection, and call handling settings.

- `start_time` (string, required) — Start time in HH:MM 24-hour format
- `end_time` (string, required) — End time in HH:MM 24-hour format
- `allowed_days` (list of enum, required) — Days of the week when inbound calls are accepted
  - Allowed values: `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, `Saturday`, `Sunday`
- `timezone` (string, optional, default: Asia/Kolkata) — IANA timezone, e.g. 'Asia/Kolkata', 'UTC', 'America/New_York'

### WebhookConfig

- `url` (string, required)
- `metadata` (map from string to any, optional, nullable)

## Examples

**Response**

```json
{
  "items": [
    {
      "deployment_id": "dep-a1b2c3d4",
      "app_id": "my-support-agent",
      "app_version": 3,
      "phone_numbers": [
        "+918047168000"
      ],
      "channel_direction": "inbound",
      "created_by": "user@company.com",
      "created_at": "2026-03-01T10:00:00Z",
      "updated_at": "2026-03-15T14:30:00Z",
      "name": "Customer Support Line",
      "status": "active",
      "description": "Main support deployment for EN and HI",
      "inbound_config": {
        "start_time": "09:00",
        "end_time": "18:00",
        "allowed_days": [
          "Monday",
          "Tuesday",
          "Wednesday",
          "Thursday",
          "Friday"
        ],
        "timezone": "Asia/Kolkata"
      },
      "updated_by": "user@company.com",
      "webhook_config": {
        "url": "https://your-server.com/webhook",
        "metadata": {
          "ref": "support-line"
        }
      }
    },
    {
      "deployment_id": "dep-e5f6g7h8",
      "app_id": "my-support-agent",
      "app_version": 4,
      "phone_numbers": [
        "+918047168001"
      ],
      "channel_direction": "inbound_outbound",
      "created_by": "user@company.com",
      "created_at": "2026-03-05T09:00:00Z",
      "updated_at": "2026-03-20T11:45:00Z",
      "name": "Sales Outbound Line",
      "status": "active",
      "description": "Outbound sales follow-ups with call-completion webhooks",
      "inbound_config": {
        "start_time": "00:00",
        "end_time": "23:59",
        "allowed_days": [
          "Monday",
          "Tuesday",
          "Wednesday",
          "Thursday",
          "Friday",
          "Saturday",
          "Sunday"
        ],
        "timezone": "Asia/Kolkata"
      },
      "updated_by": "user@company.com",
      "webhook_config": {
        "url": "https://your-server.com/campaign-events",
        "metadata": {
          "ref": "sales-outbound"
        }
      }
    }
  ],
  "total": 2,
  "limit": 10,
  "offset": 0,
  "next_page_uri": null,
  "prev_page_uri": null
}
```

**SDK Code**

```python
import requests

url = "https://apps.sarvam.ai/api/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments"

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

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

print(response.json())
```

```javascript
const url = 'https://apps.sarvam.ai/api/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments';
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/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments"

	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/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments")

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/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments")
  .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/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments', [
  'headers' => [
    'X-API-Key' => '<your-api-key>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://apps.sarvam.ai/api/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments");
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/app-authoring/v1/orgs/org_id/workspaces/workspace_id/deployments")! 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()
```