Skip to main content

Doppel API

The Doppel API provides programmatic access to your interaction data, metrics, campaigns, and clinic information. Use it to build integrations, generate reports, or power your own dashboards.

What you can do

Base URL

All API requests should be made to:
https://api.getdoppel.ai/api/v1

Response Format

All responses follow a consistent JSON format:
{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "limit": 25,
    "total": 100,
    "total_pages": 4,
    "has_more": true
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Error Handling

When an error occurs, the response will include an error object:
{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid query parameters",
    "details": { ... }
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Error Codes

CodeHTTP StatusDescription
UNAUTHORIZED401Missing or invalid Authorization header
INVALID_API_KEY401The API key is invalid
API_KEY_EXPIRED401The API key has expired
FORBIDDEN403The API key lacks required permissions
RATE_LIMITED429Rate limit exceeded
VALIDATION_ERROR400Invalid request parameters
NOT_FOUND404Resource not found
INTERNAL_ERROR500Internal server error