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

# Get campaign

GET https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}

Get full details of a campaign including its agent configuration, schedule, and retry policy.

Reference: https://docs.sarvam.ai/conversations/api/campaigns/get

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: agents
  version: 1.0.0
paths:
  /v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}:
    get:
      operationId: get-campaign
      summary: Get Campaign
      description: >-
        Get full details of a campaign including its agent configuration,
        schedule, and retry policy.
      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_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignDetail'
        '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
    ConnectionConfig:
      type: object
      properties:
        connection_id:
          type: string
        agent_phone_number:
          type: string
      required:
        - connection_id
        - agent_phone_number
      title: ConnectionConfig
    BaseRetryConfig:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether this retry condition is enabled
      required:
        - enabled
      title: BaseRetryConfig
    ShortDurationRetryConfig:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether short duration retry is enabled
        threshold_seconds:
          type: integer
          default: 30
          description: Calls shorter than this duration (in seconds) will be retried
      required:
        - enabled
        - threshold_seconds
      title: ShortDurationRetryConfig
    ErrorRetryConfig:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether error retry is enabled
        max_retries:
          type: integer
          default: 3
          description: Maximum number of retries for this error type (1 to 20)
        retry_interval_minutes:
          type: integer
          default: 5
          description: Minutes to wait between retries (minimum 5)
      required:
        - enabled
        - max_retries
        - retry_interval_minutes
      title: ErrorRetryConfig
    RetryOnConfig:
      type: object
      properties:
        busy:
          oneOf:
            - $ref: '#/components/schemas/BaseRetryConfig'
            - type: 'null'
          description: Retry when the line is busy
        failed:
          oneOf:
            - $ref: '#/components/schemas/BaseRetryConfig'
            - type: 'null'
          description: Retry when the call fails
        no_answer:
          oneOf:
            - $ref: '#/components/schemas/BaseRetryConfig'
            - type: 'null'
          description: Retry when there is no answer
        short_duration:
          oneOf:
            - $ref: '#/components/schemas/ShortDurationRetryConfig'
            - type: 'null'
          description: Retry when the call duration is below a threshold
        provider_error:
          oneOf:
            - $ref: '#/components/schemas/ErrorRetryConfig'
            - type: 'null'
          description: Retry on telephony provider errors
        internal_error:
          oneOf:
            - $ref: '#/components/schemas/ErrorRetryConfig'
            - type: 'null'
          default:
            enabled: true
            max_retries: 3
            retry_interval_minutes: 5
          description: Retry on internal system errors
      description: >-
        Granular retry conditions for different call outcomes (busy, failed, no
        answer, short duration, errors).
      title: RetryOnConfig
    RetryConfigOutputRetryIntervalMinutes:
      oneOf:
        - type: integer
        - type: array
          items:
            type: integer
      description: >-
        Minutes to wait between retries. Can be a single value or an array for
        variable intervals.
      title: RetryConfigOutputRetryIntervalMinutes
    RetryConfig-Output:
      type: object
      properties:
        max_retries:
          type: integer
          description: Maximum number of retry attempts (0 to 20)
        retry_on:
          $ref: '#/components/schemas/RetryOnConfig'
          description: Conditions that trigger a retry
        retry_interval_minutes:
          $ref: '#/components/schemas/RetryConfigOutputRetryIntervalMinutes'
          description: >-
            Minutes to wait between retries. Can be a single value or an array
            for variable intervals.
      required:
        - max_retries
      description: Retry policy as returned in responses.
      title: RetryConfig-Output
    WebhookConfig:
      type: object
      properties:
        url:
          type: string
        metadata:
          type:
            - object
            - 'null'
          additionalProperties:
            description: Any type
      required:
        - url
      title: WebhookConfig
    AgentConfig-Output:
      type: object
      properties:
        app_id:
          type: string
          description: ID of the agent
        app_version:
          type: integer
          description: Version of the agent to use
        app_type:
          type: string
          enum:
            - agent
          default: agent
          description: Always `agent`
        attempts_per_second:
          type: number
          format: double
          description: >-
            Rate of outbound call attempts (dials) per second. Every dial counts
            — initial calls and retries alike. Range: 0.1–500.
        connection_configs:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionConfig'
          description: Telephony connection configurations with phone numbers
        retry_config:
          $ref: '#/components/schemas/RetryConfig-Output'
          description: Retry configuration for failed or unanswered calls
        webhook_config:
          oneOf:
            - $ref: '#/components/schemas/WebhookConfig'
            - type: 'null'
          description: Optional webhook to receive call completion events
      required:
        - app_id
        - app_version
        - attempts_per_second
        - connection_configs
        - retry_config
      description: Agent configuration as returned in responses.
      title: AgentConfig-Output
    CampaignDetailAppConfig:
      oneOf:
        - $ref: '#/components/schemas/AgentConfig-Output'
      description: Agent configuration for the campaign
      title: CampaignDetailAppConfig
    DaysOfWeek:
      type: string
      enum:
        - Monday
        - Tuesday
        - Wednesday
        - Thursday
        - Friday
        - Saturday
        - Sunday
      description: Days of the week for scheduling.
      title: DaysOfWeek
    AllowedScheduleConfig:
      type: object
      properties:
        timezone:
          type: string
          format: zoneinfo
          description: IANA timezone, e.g. 'Asia/Kolkata', 'UTC', 'America/New_York'
        allowed_start_time:
          type: string
          description: Start time in HH:MM 24-hour format
        allowed_end_time:
          type: string
          description: End time in HH:MM 24-hour format
        allowed_days:
          type: array
          items:
            $ref: '#/components/schemas/DaysOfWeek'
          description: Days of the week when the campaign can run
      required:
        - allowed_start_time
        - allowed_end_time
        - allowed_days
      description: Business hours configuration defining when a campaign can make calls.
      title: AllowedScheduleConfig
    CampaignDetail:
      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)
        app_config:
          $ref: '#/components/schemas/CampaignDetailAppConfig'
          description: Agent configuration for the campaign
        start_timestamp:
          type: string
          format: date-time
          description: Campaign start time (ISO 8601)
        end_timestamp:
          type: string
          format: date-time
          description: Campaign end time (ISO 8601)
        allowed_schedule:
          $ref: '#/components/schemas/AllowedScheduleConfig'
          description: Schedule constraints for when the campaign can run
      required:
        - name
        - campaign_id
        - status
        - app_id
        - created_by
        - created_at
        - updated_at
        - app_config
        - start_timestamp
        - end_timestamp
        - allowed_schedule
      description: >-
        Full campaign details including agent configuration, schedule, and retry
        policy.
      title: CampaignDetail
    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
{
  "name": "Q1 Payment Reminders",
  "campaign_id": "camp-a1b2c3d4",
  "status": "active",
  "app_id": "payment-reminder-agent",
  "created_by": "user@company.com",
  "created_at": "2026-03-28T10:00:00Z",
  "updated_at": "2026-04-01T09:00:00Z",
  "app_config": {
    "app_id": "payment-reminder-agent",
    "app_type": "agent",
    "app_version": 2,
    "attempts_per_second": 2,
    "connection_configs": [
      {
        "connection_id": "conn-exotel-001",
        "phone_numbers": [
          "+918047168000"
        ],
        "weight": 1
      }
    ],
    "retry_config": {
      "max_retries": 3,
      "retry_interval_minutes": 30
    }
  },
  "start_timestamp": "2026-04-01T09:00:00Z",
  "end_timestamp": "2026-04-15T18:00:00Z",
  "allowed_schedule": {
    "allowed_start_time": "09:00",
    "allowed_end_time": "18:00",
    "allowed_days": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "timezone": "Asia/Kolkata"
  },
  "description": "Remind customers about upcoming payment due dates",
  "app_type": "agent",
  "app_version": 2,
  "updated_by": "user@company.com"
}
```

**SDK Code**

```python
import requests

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

response = requests.get(url)

print(response.json())
```

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

	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/campaign_id")

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<String> response = Unirest.get("https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns/campaign_id")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns/campaign_id');

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

```csharp
using RestSharp;

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