API Reference

Explore the full Cara API. All endpoints require authentication via Bearer token using your API key.

Endpoints by category

Patients

• List patients — GET /patients
• Create a patient — POST /patients
• Get a patient — GET /patients/{id}
• Update a patient — PUT /patients/{id}
• Get clinical data — GET /patients/{id}/clinical
• List tags — GET /patients/tags
• List custom fields — GET /patients/custom-fields

Scheduling

• List appointments — GET /scheduling/appointments
• Get availability — GET /scheduling/availability
• Book appointment — POST /scheduling/book
• List schedulers — GET /schedulers
• Create scheduler — POST /schedulers

Forms

• List forms — GET /forms
• Create a form — POST /forms
• Submit a form — POST /forms/{id}/submit

Email

• List templates — GET /emails/templates
• Create template — POST /emails/templates
• List sequences — GET /emails/sequences
• Create sequence — POST /emails/sequences
• Enroll in sequence — POST /emails/sequences/{id}/enroll
• Send email — POST /emails/send

SMS

• List templates — GET /sms/templates
• Create template — POST /sms/templates

Settings

• Get portal settings — GET /settings/portal
• Update portal settings — POST /settings/portal
• Get practice settings — GET /settings/practice
• Update practice settings — POST /settings/practice
• Get brand settings — GET /settings/brand
• Update brand settings — POST /settings/brand
• List API keys — GET /settings/portal-access-keys
• Create API key — POST /settings/portal-access-keys
• Delete API key — DELETE /settings/portal-access-keys/{keyId}