API Reference

Call Cleo provides a RESTful API for integrating with your existing systems.

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Base URL

https://api.callcleo.app/v1

Endpoints

Appointments

List Appointments

GET /appointments

Create Appointment

POST /appointments

Update Appointment

PUT /appointments/:id

Cancel Appointment

DELETE /appointments/:id

Patients

List Patients

GET /patients

Get Patient

GET /patients/:id

Create Patient

POST /patients

Availability

Check Availability

GET /availability

Query parameters:

• serviceId: Service ID
• practitionerId: Practitioner ID (optional)
• startDate: Start date (ISO 8601)
• endDate: End date (ISO 8601)

Response Format

All API responses follow a consistent format:

{
  "success": true,
  "data": {},
  "message": "Optional message"
}

Error Handling

Errors are returned with appropriate HTTP status codes:

• 400: Bad Request
• 401: Unauthorized
• 404: Not Found
• 500: Internal Server Error

Rate Limiting

API requests are rate-limited to ensure fair usage. Check response headers for rate limit information.