CaraCara API

Quickstart

Make your first API call in under 5 minutes.

Prerequisites

1. Create a patient

curl -X POST https://platform.caramedical.com/api/v1/patients \
  -H "Authorization: Bearer sk_test_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane.doe@example.com",
    "phone": "+15551234567",
    "dateOfBirth": "1990-01-15"
  }'

Response:

{
  "id": "pat_abc123",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "phone": "+15551234567",
  "dateOfBirth": "1990-01-15",
  "status": "active",
  "createdAt": "2025-01-15T10:30:00Z"
}

2. List your patients

curl -X GET https://platform.caramedical.com/api/v1/patients \
  -H "Authorization: Bearer sk_test_your_key_here"

Response:

{
  "data": [
    {
      "id": "pat_abc123",
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "jane.doe@example.com",
      "status": "active"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "total": 1
  }
}

3. Check appointment availability

curl -X GET "https://platform.caramedical.com/api/v1/scheduling/availability?date=2025-02-01" \
  -H "Authorization: Bearer sk_test_your_key_here"

Next steps

Previous

Authentication

Next

Environments

On this page