List Campaigns

curl --request GET \
  --url https://api.getdoppel.ai/api/v1/api/v1/campaigns \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getdoppel.ai/api/v1/api/v1/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://api.getdoppel.ai/api/v1/api/v1/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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.getdoppel.ai/api/v1/api/v1/campaigns"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getdoppel.ai/api/v1/api/v1/campaigns")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "data": {
    "campaigns": [
      {}
    ]
  },
  "meta": {}
}

GET

api

campaigns

List Campaigns

curl --request GET \
  --url https://api.getdoppel.ai/api/v1/api/v1/campaigns \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getdoppel.ai/api/v1/api/v1/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://api.getdoppel.ai/api/v1/api/v1/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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.getdoppel.ai/api/v1/api/v1/campaigns"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getdoppel.ai/api/v1/api/v1/campaigns")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "data": {
    "campaigns": [
      {}
    ]
  },
  "meta": {}
}

List Campaigns

Returns a list of all campaigns configured in your account. Campaigns represent different outreach initiatives like no-show recovery, patient reactivation, appointment reminders, and more.

Request

GET https://api.getdoppel.ai/api/v1/campaigns

Headers

Header	Required	Description
`Authorization`	Yes	Bearer token with your API key

Query Parameters

Parameter	Type	Default	Description
`page`	integer	1	Page number (1-indexed)
`limit`	integer	25	Items per page (max: 500)
`clinic_id`	string	-	Filter by clinic UUID
`status`	string	-	Filter by status: `active`, `paused`, `completed`

Response

boolean

Whether the request was successful

object

Show properties

array

Array of campaign objects

object

Pagination metadata

Campaign Object

Field	Type	Description
`id`	string	Unique campaign ID
`name`	string	Campaign name
`description`	string	Campaign description
`type`	string	Campaign type (e.g., `no_show_recovery`, `reactivation`)
`channel`	string	Channel used: `voice`, `whatsapp`, or `multi`
`status`	string	Current status: `active`, `paused`, `completed`
`clinic_id`	string	Associated clinic UUID
`created_at`	string	When the campaign was created (ISO 8601)
`updated_at`	string	Last update timestamp (ISO 8601)
`settings`	object	Campaign configuration settings

Examples

Basic Request

curl -X GET "https://api.getdoppel.ai/api/v1/campaigns" \
  -H "Authorization: Bearer dpl_live_YOUR_API_KEY"

const response = await fetch('https://api.getdoppel.ai/api/v1/campaigns', {
  headers: {
    'Authorization': 'Bearer dpl_live_YOUR_API_KEY'
  }
});
const data = await response.json();

import requests

response = requests.get(
    'https://api.getdoppel.ai/api/v1/campaigns',
    headers={'Authorization': 'Bearer dpl_live_YOUR_API_KEY'}
)
data = response.json()

Filter Active Campaigns

curl -X GET "https://api.getdoppel.ai/api/v1/campaigns?status=active" \
  -H "Authorization: Bearer dpl_live_YOUR_API_KEY"

const response = await fetch(
  'https://api.getdoppel.ai/api/v1/campaigns?status=active',
  {
    headers: {
      'Authorization': 'Bearer dpl_live_YOUR_API_KEY'
    }
  }
);

import requests

response = requests.get(
    'https://api.getdoppel.ai/api/v1/campaigns',
    params={'status': 'active'},
    headers={'Authorization': 'Bearer dpl_live_YOUR_API_KEY'}
)

Filter by Clinic

curl -X GET "https://api.getdoppel.ai/api/v1/campaigns?clinic_id=550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer dpl_live_YOUR_API_KEY"

const response = await fetch(
  'https://api.getdoppel.ai/api/v1/campaigns?clinic_id=550e8400-e29b-41d4-a716-446655440000',
  {
    headers: {
      'Authorization': 'Bearer dpl_live_YOUR_API_KEY'
    }
  }
);

import requests

response = requests.get(
    'https://api.getdoppel.ai/api/v1/campaigns',
    params={'clinic_id': '550e8400-e29b-41d4-a716-446655440000'},
    headers={'Authorization': 'Bearer dpl_live_YOUR_API_KEY'}
)

Response Example

{
  "success": true,
  "data": {
    "campaigns": [
      {
        "id": "camp_abc123",
        "name": "No-Show Recovery",
        "description": "Reach out to patients who missed their appointments",
        "type": "no_show_recovery",
        "channel": "voice",
        "status": "active",
        "clinic_id": "550e8400-e29b-41d4-a716-446655440000",
        "created_at": "2024-01-01T00:00:00.000Z",
        "updated_at": "2024-01-15T10:30:00.000Z",
        "settings": {
          "max_attempts": 3,
          "retry_interval_hours": 24,
          "call_window_start": "09:00",
          "call_window_end": "18:00"
        }
      },
      {
        "id": "camp_def456",
        "name": "Patient Reactivation",
        "description": "Re-engage patients who haven't visited in 6+ months",
        "type": "reactivation",
        "channel": "whatsapp",
        "status": "active",
        "clinic_id": "550e8400-e29b-41d4-a716-446655440000",
        "created_at": "2024-02-01T00:00:00.000Z",
        "updated_at": "2024-02-15T14:20:00.000Z",
        "settings": {
          "inactivity_threshold_days": 180,
          "message_template": "reactivation_v2"
        }
      },
      {
        "id": "camp_ghi789",
        "name": "Appointment Reminders",
        "description": "Send reminders 24h before appointments",
        "type": "appointment_reminder",
        "channel": "whatsapp",
        "status": "active",
        "clinic_id": "550e8400-e29b-41d4-a716-446655440000",
        "created_at": "2024-01-15T00:00:00.000Z",
        "updated_at": "2024-01-15T00:00:00.000Z",
        "settings": {
          "reminder_hours_before": 24,
          "allow_reschedule": true,
          "allow_cancel": true
        }
      }
    ]
  },
  "meta": {
    "page": 1,
    "limit": 25,
    "total": 3,
    "total_pages": 1,
    "has_more": false
  },
  "request_id": "req_abc123xyz",
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Campaign Types

Type	Description
`no_show_recovery`	Contact patients who missed appointments
`reactivation`	Re-engage inactive patients
`appointment_reminder`	Send appointment reminders
`follow_up`	Post-appointment follow-up
`recall`	Periodic health check reminders
`custom`	Custom campaign types

Use Cases

List All Active Campaigns

async function getActiveCampaigns(apiKey) {
  const response = await fetch(
    'https://api.getdoppel.ai/api/v1/campaigns?status=active',
    {
      headers: { 'Authorization': `Bearer ${apiKey}` }
    }
  );
  const { data } = await response.json();
  return data.campaigns;
}

Get Campaigns by Type

import requests

def get_campaigns_by_type(api_key, campaign_type):
    response = requests.get(
        'https://api.getdoppel.ai/api/v1/campaigns',
        headers={'Authorization': f'Bearer {api_key}'}
    )
    campaigns = response.json()['data']['campaigns']
    return [c for c in campaigns if c['type'] == campaign_type]

# Get all no-show recovery campaigns
no_show_campaigns = get_campaigns_by_type(
    'dpl_live_YOUR_API_KEY',
    'no_show_recovery'
)

List Clinics

Get clinic information for your campaigns.

List Interactions

View interactions generated by campaigns.

API Reference

Interactions

Metrics

Campaigns

Clinics

List Campaigns

List Campaigns

Request

Headers

Query Parameters

Response

Campaign Object

Examples

Basic Request

Filter Active Campaigns

Filter by Clinic

Response Example

Campaign Types

Use Cases

List All Active Campaigns

Get Campaigns by Type

List Clinics

List Interactions

​List Campaigns

​Request

​Headers

​Query Parameters

​Response

​Campaign Object

​Examples

​Basic Request

​Filter Active Campaigns

​Filter by Clinic

​Response Example

​Campaign Types

​Use Cases

​List All Active Campaigns

​Get Campaigns by Type

​Related Endpoints

List Clinics

List Interactions

List Campaigns

Request

Headers

Query Parameters

Response

Campaign Object

Examples

Basic Request

Filter Active Campaigns

Filter by Clinic

Response Example

Campaign Types

Use Cases

List All Active Campaigns

Get Campaigns by Type

Related Endpoints