List Campaigns

curl --request GET \
  --url https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns"

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

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns"

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns")

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

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

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

{
  "items": [
    {
      "name": "Q1 Payment Reminders",
      "campaign_id": "camp-a1b2c3d4",
      "status": "scheduled",
      "description": "Remind customers about upcoming payment due dates",
      "app_id": "payment-reminder-agent",
      "app_type": "agent",
      "app_version": 2,
      "created_by": "user@company.com",
      "created_at": "2026-03-28T10:00:00Z",
      "updated_by": null,
      "updated_at": "2026-03-28T10:00:00Z"
    }
  ],
  "total": 1,
  "limit": 10,
  "offset": 0,
  "next_page_uri": null,
  "prev_page_uri": null
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "data": {
      "details": {}
    }
  }
}

GET

orgs

{org_id}

workspaces

{workspace_id}

campaigns

List Campaigns

curl --request GET \
  --url https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns"

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

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns"

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns")

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

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

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

{
  "items": [
    {
      "name": "Q1 Payment Reminders",
      "campaign_id": "camp-a1b2c3d4",
      "status": "scheduled",
      "description": "Remind customers about upcoming payment due dates",
      "app_id": "payment-reminder-agent",
      "app_type": "agent",
      "app_version": 2,
      "created_by": "user@company.com",
      "created_at": "2026-03-28T10:00:00Z",
      "updated_by": null,
      "updated_at": "2026-03-28T10:00:00Z"
    }
  ],
  "total": 1,
  "limit": 10,
  "offset": 0,
  "next_page_uri": null,
  "prev_page_uri": null
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "data": {
      "details": {}
    }
  }
}

Returns a paginated list of campaigns in your workspace.

Filtering and sorting

Parameter	Default	Notes
`campaign_status`	—	Filter by status: `scheduled`, `active`, `paused`, `ended`, `cancelled`
`search`	—	Search campaigns by name
`sort_by`	`created_at`	Field to sort results by
`sort_order`	`desc`	`asc` or `desc`
`limit`	`10`	Results per page (max `100`)
`offset`	`0`	Number of results to skip for pagination

To monitor all currently running campaigns, filter with campaign_status=active. To find a specific campaign, combine search with an optional status filter.

Pagination

The response includes next_page_uri and prev_page_uri for navigating pages. Both are null when there is no adjacent page. To fetch the next page, increment offset by limit or follow next_page_uri directly.

Authorizations

X-API-Key

string

header

required

Path Parameters

org_id

string

required

workspace_id

string

required

Query Parameters

campaign_status

enum<string> | null

Campaign lifecycle status: scheduled → active → ended. Can be paused or cancelled at any point.

Available options:

ended,

active,

paused,

scheduled,

cancelled

offset

integer

default:0

Number of records to skip

Required range: x >= 0

limit

integer

default:10

Number of records to return (max 100)

Required range: 1 <= x <= 100

sort_by

string | null

default:created_at

Field to sort by

sort_order

string | null

default:desc

Sort order (asc or desc)

string | null

Search query string

Response

Successful Response

Paginated list of campaigns.

items

CampaignMetadata · object[]

required

List of campaigns on this page

Show child attributes

total

integer

required

Total number of campaigns matching the query

Example:

1

limit

integer

required

Maximum number of items per page

Example:

10

offset

integer

required

Number of items skipped

Example:

0

next_page_uri

string | null

URI to fetch the next page, or null if this is the last page

Example:

null

prev_page_uri

string | null

URI to fetch the previous page, or null if this is the first page

Example:

null

Create Campaign Get Campaign

Deployments

Campaigns

Instant Outbound

Analytics

BYOK (Bring Your Own Key) API

List Campaigns

Filtering and sorting

Authorizations

Path Parameters

Query Parameters

Response

​Filtering and sorting

​Pagination

Authorizations

Path Parameters

Query Parameters

Response

Filtering and sorting

Pagination