Skip to main content

​
Getting Started

The MaxCare Public API allows marketplace apps to access clinic data programmatically. This guide walks you through setup and your first API call.

​
Prerequisites

  1. A registered marketplace app in the MaxCare dashboard
  2. An API key generated from the app settings page

​
Base URL

All API endpoints are prefixed with: 
https://api.maxcare.ai/external/v1

​
Making Your First Request

Once you have your API key and the organization ID of the clinic you’re accessing, make a request: 
curl -X GET "https://api.maxcare.ai/external/v1/marketplace/me" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Organization-Id: org_abc123"

​
Response

{
  "code": "success",
  "data": {
    "app": {
      "id": "app_123",
      "name": "My App",
      "scopes": ["read:patients", "read:appointments"]
    },
    "organization": {
      "id": "org_abc123",
      "name": "Acme Clinic"
    }
  }
}

​
Response Format

All responses follow a consistent envelope: Success: 
{
  "code": "success",
  "data": { ... }
}
Error: 
{
  "code": "unauthorized",
  "message": "Invalid or missing API key",
  "trace_id": "550e8400-e29b-41d4-a716-446655440000"
}

​
Next Steps

  • Authentication — Learn about API key auth and headers
  • Scopes — Understand permission scopes
  • Browse the API Reference tab to see all available endpoints