> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.youratlas.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.youratlas.com/_mcp/server.

# Get campaign by ID

GET https://api.youratlas.com/v1/api/campaign/{id}

Reference: https://docs.youratlas.com/api-reference/atlas-api/campaigns/get-campaign

## Authentication

- `api-key` header (required) — Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

## Request

### Path parameters

- `id` (string, required) — The campaign ID

## Response

### 200

Successful response

- `odata.metadata` (string, optional)
- `PartitionKey` (string, optional)
- `RowKey` (string, optional)
- `Timestamp` (datetime, optional)
- `odata.etag` (string, optional)
- `name` (string, optional)
- `campaignType` (string, optional)
- `Mode` (boolean, optional)
- `BusinessName` (string, optional)
- `CallType` (string, optional)
- `CompanyName` (string, optional)
- `FirstMessage` (string, optional)
- `IsActive` (boolean, optional)
- `PhoneNumberId` (string, optional)
- `Position` (string, optional)
- `ScriptBase` (string, optional)
- `ScriptNotes` (string, optional)
- `StartDate` (datetime, optional)
- `TimeWindows` (string, optional) — JSON-encoded array of time-window objects. Each object contains startHour (0–23), startMinute (0–59), endHour (0–23), and endMinute (0–59).
- `SuccessRequest` (integer, optional)
- `TemplateId` (string, optional)
- `TotalRequest` (integer, optional)
- `TotalTransfers` (integer, optional)
- `DailyCallLimit` (integer, optional)
- `KnowledgeBaseId` (string, optional)
- `KnowledgeBaseDataSetId` (string, optional) — Knowledge base dataset identifier
- `FeatureAppendPreviousSummaryEnabled` (boolean, optional)
- `PhoneNumberProvider` (string, optional)
- `FeatureRescheduleCallEnabled` (boolean, optional)
- `EnrichmentInfoSettings` (string, optional)
- `EnrichmentInfoProvider` (string, optional)
- `FeatureEnrichmentInfoEnabled` (boolean, optional)
- `EndCallMessage` (string, optional)
- `VoicemailMessage` (string, optional)
- `AnalysisPlanSummaryPrompt` (string, optional)
- `AnalysisPlanSuccessEvaluationPrompt` (string, optional)
- `AnalysisPlanStructuredDataPrompt` (string, optional)
- `FeatureEndCallWhenVoicemail` (boolean, optional)
- `VoicemailDropMechanism` (enum, optional) — Voicemail drop strategy. `audio-detection` detects voicemail via audio analysis and drops a pre-recorded message. `ringless` delivers a voicemail without ringing the recipient's phone.
  - Allowed values: `audio-detection`, `ringless`
- `FeatureRedialOnNoResponse` (boolean, optional)
- `RedialSettings` (string, optional) — JSON string of redial attempt configuration
- `FeatureDoubleCall` (boolean, optional)
- `Timezone` (string, optional)
- `TimezoneFriendlyName` (string, optional)
- `Status` (enum, optional)
  - Allowed values: `archived`, `active`, `draft`
- `Collection` (string, optional)
- `IdleMessages` (string, optional)
- `ToolIds` (string, optional)
- `SMSTrigger` (string, optional)
- `SMSBody` (string, optional)
- `ForwardingPhoneNumber` (string, optional)
- `PreScript` (string, optional)
- `PostScript` (string, optional)
- `FirstMessageMode` (enum, optional)
  - Allowed values: `assistant-speaks-first`, `assistant-waits-for-user`, `assistant-speaks-first-with-model-generated-message`
- `ChatPhoneNumberId` (string, optional)
- `IsOutboundChatActive` (boolean, optional)
- `ChatReplyPacingEnabled` (boolean, optional) — Whether AI chat reply pacing is enabled. When true, reply bubbles are sent with a typing indicator and a short delay, making conversations feel more natural. Messages campaigns only.
- `ChatReplyPacingSeconds` (integer, optional) — Fixed per-bubble typing duration in seconds (1–60). When absent or 0 the duration is auto-calculated based on message length. Messages campaigns only.
- `AIAssistantProvider` (enum, optional, nullable) — AI assistant runtime powering this campaign. Returns "atlas" when the campaign uses the Atlas runtime, or null otherwise.
  - Allowed values: `atlas`
- `TotalBooked` (double, optional)
- `AtlasKnowledgeBaseId` (string, optional)
- `MarketplaceAgentId` (string, optional)
- `AgentType` (string, optional)
- `language` (string, optional)
- `voiceId` (string, optional)

## Errors

### 404 Not Found Error

Resource not found

- `error` (ErrorError, optional)

### 500 Internal Server Error

Internal server error

- `error` (ErrorError, optional)

## Types

### ErrorError

- `message` (string, optional)
- `code` (string, optional)
- `requestId` (string, optional)

## Examples

**Response**

```json
{
  "odata.metadata": "string",
  "PartitionKey": "string",
  "RowKey": "string",
  "Timestamp": "2024-01-15T09:30:00Z",
  "odata.etag": "string",
  "name": "string",
  "campaignType": "string",
  "Mode": true,
  "BusinessName": "string",
  "CallType": "string",
  "CompanyName": "string",
  "FirstMessage": "string",
  "IsActive": true,
  "PhoneNumberId": "string",
  "Position": "string",
  "ScriptBase": "string",
  "ScriptNotes": "string",
  "StartDate": "2024-01-15T09:30:00Z",
  "TimeWindows": "string",
  "SuccessRequest": 1,
  "TemplateId": "string",
  "TotalRequest": 1,
  "TotalTransfers": 1,
  "DailyCallLimit": 1,
  "KnowledgeBaseId": "string",
  "KnowledgeBaseDataSetId": "string",
  "FeatureAppendPreviousSummaryEnabled": true,
  "PhoneNumberProvider": "string",
  "FeatureRescheduleCallEnabled": true,
  "EnrichmentInfoSettings": "string",
  "EnrichmentInfoProvider": "string",
  "FeatureEnrichmentInfoEnabled": true,
  "EndCallMessage": "string",
  "VoicemailMessage": "string",
  "AnalysisPlanSummaryPrompt": "string",
  "AnalysisPlanSuccessEvaluationPrompt": "string",
  "AnalysisPlanStructuredDataPrompt": "string",
  "FeatureEndCallWhenVoicemail": true,
  "VoicemailDropMechanism": "audio-detection",
  "FeatureRedialOnNoResponse": true,
  "RedialSettings": "string",
  "FeatureDoubleCall": true,
  "Timezone": "string",
  "TimezoneFriendlyName": "string",
  "Status": "archived",
  "Collection": "string",
  "IdleMessages": "string",
  "ToolIds": "string",
  "SMSTrigger": "string",
  "SMSBody": "string",
  "ForwardingPhoneNumber": "string",
  "PreScript": "string",
  "PostScript": "string",
  "FirstMessageMode": "assistant-speaks-first",
  "ChatPhoneNumberId": "string",
  "IsOutboundChatActive": true,
  "ChatReplyPacingEnabled": true,
  "ChatReplyPacingSeconds": 1,
  "AIAssistantProvider": "atlas",
  "TotalBooked": 1.1,
  "AtlasKnowledgeBaseId": "string",
  "MarketplaceAgentId": "string",
  "AgentType": "string",
  "language": "string",
  "voiceId": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.youratlas.com/v1/api/campaign/id"

headers = {"api-key": "<apiKey>"}

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

print(response.json())
```

```javascript
const url = 'https://api.youratlas.com/v1/api/campaign/id';
const options = {method: 'GET', headers: {'api-key': '<apiKey>'}};

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://api.youratlas.com/v1/api/campaign/id"

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

	req.Header.Add("api-key", "<apiKey>")

	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://api.youratlas.com/v1/api/campaign/id")

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

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

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://api.youratlas.com/v1/api/campaign/id")
  .header("api-key", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.youratlas.com/v1/api/campaign/id', [
  'headers' => [
    'api-key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.youratlas.com/v1/api/campaign/id");
var request = new RestRequest(Method.GET);
request.AddHeader("api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.youratlas.com/v1/api/campaign/id")! 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()
```