Developer Platform

Build on FrontDesk.

REST APIs, webhooks, and SDKs to integrate AI reception into your practice management workflow — or build something entirely new.

Quick Start Guide API Reference

API Reference

RESTful APIs for Every Resource

JSON-based REST API with consistent patterns. Bearer token auth, pagination, filtering, and detailed error responses.

Appointments

Create, read, update, and cancel appointments. Query by date range, provider, location, or status.

GET /api/appointmentsPOST /api/appointments/bookPATCH /api/appointments/:idDELETE /api/appointments/:id

Call Logs

Access call history, recordings, transcripts, and AI-generated summaries for every inbound call.

GET /api/calls/logsGET /api/calls/logs/:callSidGET /api/calls/logs/:callSid/transcriptGET /api/calls/logs/:callSid/recording

Patients

Manage patient records, demographics, contact information, and communication preferences.

GET /api/patientsPOST /api/patientsPATCH /api/patients/:idGET /api/patients/:id/history

Practice Configuration

Manage practice settings, business hours, services, providers, and AI receptionist behavior.

GET /api/practices/:idPATCH /api/practices/:idGET /api/practices/:id/hoursPUT /api/practices/:id/services

Analytics

Pull call volume, booking conversion, no-show rates, and revenue metrics for reporting dashboards.

GET /api/analytics/callsGET /api/analytics/appointmentsGET /api/analytics/revenueGET /api/analytics/performance

Webhooks

Receive real-time HTTP callbacks for events like new calls, bookings, cancellations, and no-shows.

POST /api/webhooksGET /api/webhooksDELETE /api/webhooks/:idPOST /api/webhooks/:id/test

Quick Start

Up and Running in Minutes

Four steps from zero to your first API call.

Get Your API Key

Generate an API key from Settings → Developer in your FrontDesk dashboard. Keys are scoped per practice.

Make Your First Call

Use curl or your preferred HTTP client to hit GET /api/practices/:id and verify authentication works.

Register a Webhook

POST to /api/webhooks with your endpoint URL and the events you want to subscribe to.

Build & Ship

Use our API reference and code examples to build your integration. We review and certify partner integrations.

Code Examples

See It in Action

Copy-paste examples to get started fast.

Fetch Appointments

// Example: List today's appointments
const response = await fetch(
  'https://api.frontdesk.care/v1/appointments?date=today',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
  }
);

const { appointments } = await response.json();
console.log(`Found ${appointments.length} appointments`);

Webhook Payload

// Example: Webhook payload for call.completed
{
  "event": "call.completed",
  "timestamp": "2025-01-15T14:32:00Z",
  "data": {
    "callSid": "CA1234567890abcdef",
    "direction": "inbound",
    "duration": 127,
    "callerPhone": "+15551234567",
    "outcome": "appointment_booked",
    "appointmentId": "apt_abc123",
    "transcript": "Hi, I'd like to schedule..."
  }
}

Webhooks

Real-Time Event Notifications

Subscribe to events and receive instant HTTP callbacks. Retry logic and HMAC signature verification included.

EventDescription

call.completedFired when an inbound call ends. Includes transcript, duration, and outcome.

appointment.bookedFired when a new appointment is scheduled by the AI or via API.

appointment.cancelledFired when an appointment is cancelled by the patient or staff.

appointment.reminderFired when an automated reminder is sent (SMS or call).

patient.createdFired when a new patient record is added to the system.

voicemail.receivedFired when a voicemail is left and transcribed by the AI.

SDKs & Libraries

Official Client Libraries

Type-safe wrappers around the REST API. Install via your package manager.

JavaScript / Node.js

Available

npm install @frontdesk/sdk

Python

Available

pip install frontdesk-sdk

Ruby

Coming Soon

gem install frontdesk

PHP

Coming Soon

composer require frontdesk/sdk

Questions

Developer FAQ

Common questions from developers and integration partners.

Yes. The default rate limit is 100 requests per minute per API key. Enterprise customers can request higher limits. Rate limit headers (X-RateLimit-Remaining, X-RateLimit-Reset) are included in every response.

All API requests require a Bearer token in the Authorization header. Generate API keys from your FrontDesk dashboard under Settings → Developer. Keys can be scoped to specific practices.

API access is included with Professional and Enterprise plans at no additional cost. Starter plans can access read-only endpoints. Usage is subject to rate limits.

Yes. Every API key can be toggled between live and sandbox mode. Sandbox requests return realistic test data without affecting your production environment.

We retry failed webhook deliveries with exponential backoff — 1 min, 5 min, 30 min, 2 hours, then daily for 3 days. After 7 consecutive failures, the webhook is disabled and you receive an email notification.

Absolutely. We offer a Partner Integration Program with dedicated support, co-marketing, and listing in our integrations directory. Contact partnerships@frontdesk.care to apply.

Ready to Build?

Generate your API key and start integrating FrontDesk into your workflow today.

Get API Key Contact Developer Support

Setup in 10 minutes•Cancel anytime