Quickstart

This guide will help you make your first API request in just a few minutes.

Step 1: Get your API key

Contact your Doppel account manager to receive your API key. The key will look like:

dpl_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Keep your API key secure. Never expose it in client-side code or public repositories.

Step 2: Make your first request

Let’s start by listing your clinics. Replace YOUR_API_KEY with your actual key:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.getdoppel.ai/api/v1/clinics"

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

import requests

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

Step 3: Explore interactions

Now let’s fetch your recent interactions:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.getdoppel.ai/api/v1/interactions?limit=10"

const response = await fetch(
  'https://api.getdoppel.ai/api/v1/interactions?limit=10',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);
const data = await response.json();
console.log(data);

import requests

response = requests.get(
    'https://api.getdoppel.ai/api/v1/interactions',
    params={'limit': 10},
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
data = response.json()
print(data)

Step 4: Get metrics

Retrieve aggregated metrics for a date range:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.getdoppel.ai/api/v1/metrics/summary?date_from=2024-01-01&date_to=2024-12-31"

const response = await fetch(
  'https://api.getdoppel.ai/api/v1/metrics/summary?date_from=2024-01-01&date_to=2024-12-31',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);
const data = await response.json();
console.log(data);

import requests

response = requests.get(
    'https://api.getdoppel.ai/api/v1/metrics/summary',
    params={
        'date_from': '2024-01-01',
        'date_to': '2024-12-31'
    },
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
data = response.json()
print(data)

Step 5: Get your bookings

Retrieve all appointment-related interactions (booked, modified, cancelled):

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.getdoppel.ai/api/v1/interactions?outcome=APPOINTMENT_BOOKED,APPOINTMENT_MODIFIED,APPOINTMENT_CANCELLED"

const response = await fetch(
  'https://api.getdoppel.ai/api/v1/interactions?outcome=APPOINTMENT_BOOKED,APPOINTMENT_MODIFIED,APPOINTMENT_CANCELLED',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);
const data = await response.json();
console.log(`Found ${data.data.interactions.length} bookings`);

import requests

response = requests.get(
    'https://api.getdoppel.ai/api/v1/interactions',
    params={'outcome': 'APPOINTMENT_BOOKED,APPOINTMENT_MODIFIED,APPOINTMENT_CANCELLED'},
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
data = response.json()
print(f"Found {len(data['data']['interactions'])} bookings")

You can filter by multiple outcomes using comma-separated values. See Filtering Interactions for more options.

Next steps

Authentication

Learn more about API key authentication and scopes.

Rate Limits

Understand rate limiting and how to handle it.

Filtering Interactions

Master the powerful filtering options for interactions.

API Reference

Explore all available endpoints.

​Quickstart

​Step 1: Get your API key

​Step 2: Make your first request

​Step 3: Explore interactions

​Step 4: Get metrics

​Step 5: Get your bookings

​Next steps

Authentication

Rate Limits

Filtering Interactions

API Reference

Quickstart

Step 1: Get your API key

Step 2: Make your first request

Step 3: Explore interactions

Step 4: Get metrics

Step 5: Get your bookings

Next steps