> 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 campaigns GET https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns List campaigns in the workspace with optional filtering by status, search, sorting, and pagination. Reference: https://docs.sarvam.ai/api-reference/campaigns/list ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: agents version: 1.0.0 paths: /v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns: get: operationId: list-campaigns summary: List Campaigns description: >- List campaigns in the workspace with optional filtering by status, search, sorting, and pagination. tags: - v1-campaigns parameters: - name: org_id in: path required: true schema: type: string - name: workspace_id in: path required: true schema: type: string - name: campaign_status in: query required: false schema: oneOf: - $ref: '#/components/schemas/CampaignStatus' - type: 'null' - name: offset in: query description: Number of records to skip required: false schema: type: integer default: 0 - name: limit in: query description: Number of records to return (max 100) required: false schema: type: integer default: 10 - name: sort_by in: query description: Field to sort by required: false schema: type: - string - 'null' default: created_at - name: sort_order in: query description: Sort order (asc or desc) required: false schema: type: - string - 'null' default: desc - name: search in: query description: Search query string required: false schema: type: - string - 'null' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaginatedCampaignMetadata' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' servers: - url: https://apps.sarvam.ai/api/scheduling description: Production components: schemas: CampaignStatus: type: string enum: - ended - active - paused - scheduled - cancelled description: >- Campaign lifecycle status: `scheduled` → `active` → `ended`. Can be `paused` or `cancelled` at any point. title: CampaignStatus AppType: type: string enum: - agent title: AppType CampaignMetadata: type: object properties: name: type: string description: Name of the resource campaign_id: type: string description: Unique identifier for the campaign status: $ref: '#/components/schemas/CampaignStatus' description: Current status description: type: - string - 'null' description: Optional description app_id: type: string description: ID of the agent app_type: $ref: '#/components/schemas/AppType' description: Type of agent app_version: type: - integer - 'null' description: Version of the agent to use created_by: type: string description: User who created this resource created_at: type: string format: date-time description: Timestamp when the resource was created (ISO 8601) updated_by: type: - string - 'null' description: User who last updated this resource updated_at: type: string format: date-time description: Timestamp when the resource was last updated (ISO 8601) required: - name - campaign_id - status - app_id - created_by - created_at - updated_at description: Summary metadata for a campaign, returned in list responses. title: CampaignMetadata PaginatedCampaignMetadata: type: object properties: items: type: array items: $ref: '#/components/schemas/CampaignMetadata' description: List of campaigns on this page total: type: integer description: Total number of campaigns matching the query limit: type: integer description: Maximum number of items per page offset: type: integer description: Number of items skipped next_page_uri: type: - string - 'null' description: URI to fetch the next page, or null if this is the last page prev_page_uri: type: - string - 'null' description: URI to fetch the previous page, or null if this is the first page required: - items - total - limit - offset description: Paginated list of campaigns. title: PaginatedCampaignMetadata ErrorBody: type: object properties: code: type: string description: A service-specific error code. message: type: string description: A human-readable description of the error. required: - code - message description: Details of the error that occurred. title: ErrorBody ErrorResponse: type: object properties: error: $ref: '#/components/schemas/ErrorBody' required: - error description: A standard wrapper for all error responses. title: ErrorResponse ``` ## Examples **Response** ```json { "items": [ { "name": "Q1 Payment Reminders", "campaign_id": "camp-a1b2c3d4", "status": "scheduled", "app_id": "payment-reminder-agent", "created_by": "user@company.com", "created_at": "2026-03-28T10:00:00Z", "updated_at": "2026-03-28T10:00:00Z", "description": "Remind customers about upcoming payment due dates", "app_type": "agent", "app_version": 2, "updated_by": null } ], "total": 1, "limit": 10, "offset": 0, "next_page_uri": null, "prev_page_uri": null } ``` **SDK Code** ```python import requests url = "https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns" response = requests.get(url) print(response.json()) ``` ```javascript const url = 'https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns'; const options = {method: 'GET'}; 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/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns" req, _ := http.NewRequest("GET", url, nil) 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/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) response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns") .asString(); ``` ```php request('GET', 'https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns'); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let request = NSMutableURLRequest(url: NSURL(string: "https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" 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() ```