Get all campaigns | Atlas

curl https://api.youratlas.com/v1/api/campaign \
     -H "api-key: <apiKey>" \
     -H "Content-Type: application/json"

{
  "odata.metadata": "https://api.youratlas.com/v1/api/$metadata#campaign",
  "value": [
    {
      "PartitionKey": "campaigns",
      "RowKey": "c1234567890abcdef",
      "Timestamp": "2024-01-15T09:30:00Z",
      "odata.etag": "W/\"datetime'2024-01-15T09%3A30%3A00.0000000Z'\"",
      "name": "Spring Product Launch",
      "campaignType": "voice",
      "Mode": true,
      "BusinessName": "GreenTech Solutions",
      "CallType": "outbound",
      "CompanyName": "GreenTech Solutions Inc.",
      "FirstMessage": "Hello, this is a call from GreenTech Solutions about our new spring products.",
      "IsActive": true,
      "PhoneNumberId": "pn-9876543210",
      "Position": "Marketing Manager",
      "ScriptBase": "Welcome to our spring campaign. Please listen carefully to the offers.",
      "ScriptNotes": "Emphasize eco-friendly benefits.",
      "StartDate": "2024-01-15T09:30:00Z",
      "TimeWindows": "09:00-17:00",
      "SuccessRequest": 150,
      "TemplateId": "tmpl-2024-spring",
      "TotalRequest": 200,
      "TotalTransfers": 25,
      "DailyCallLimit": 100,
      "KnowledgeBaseId": "kb-gt-solutions",
      "KnowledgeBaseDataSetId": "dataset-2024-spring",
      "FeatureAppendPreviousSummaryEnabled": true,
      "PhoneNumberProvider": "Twilio",
      "FeatureRescheduleCallEnabled": true,
      "EnrichmentInfoSettings": "{\"includeCustomerHistory\":true}",
      "EnrichmentInfoProvider": "Clearbit",
      "FeatureEnrichmentInfoEnabled": true,
      "EndCallMessage": "Thank you for your time. Have a great day!",
      "VoicemailMessage": "Hi, we missed you. Please call us back at your convenience.",
      "AnalysisPlanSummaryPrompt": "Summarize customer feedback and call outcomes.",
      "FeatureEndCallWhenVoicemail": true,
      "FeatureRedialOnNoResponse": true,
      "RedialSettings": "{\"maxAttempts\":3,\"intervalMinutes\":15}",
      "FeatureDoubleCall": true,
      "Timezone": "America/New_York",
      "TimezoneFriendlyName": "Eastern Standard Time",
      "Status": "active",
      "Collection": "spring_campaigns",
      "IdleMessages": "No new messages at this time.",
      "ToolIds": "tool-voice-analytics,tool-customer-insights",
      "SMSTrigger": "onMissedCall",
      "SMSBody": "Sorry we missed you! Reply to schedule a callback.",
      "ForwardingPhoneNumber": "+12345678901",
      "PreScript": "Verify customer identity before proceeding.",
      "PostScript": "Log call outcome and update CRM.",
      "FirstMessageMode": "assistant-speaks-first",
      "ChatPhoneNumberId": "chat-pn-1234567890",
      "IsOutboundChatActive": true
    }
  ]
}

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Response

Successful response

odata.metadatastring

valuelist of objects

Errors

500

Internal Server Error