Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/FlasheyEstudi/Oasis-Liquido/llms.txt

Use this file to discover all available pages before exploring further.

Administrators have cross-cutting visibility into every part of Oasis Liquido. You are responsible for provisioning clinics and pharmacies, onboarding and managing user accounts across all roles, and monitoring platform health through real-time statistics and an immutable audit trail.

​
What administrators can do

  • View platform-wide AdminStats covering all entities and revenue
  • Create, update, and deactivate clinics and pharmacies
  • Manage user accounts — create users, assign roles, and toggle is_active
  • Assign doctors to clinics and pharmacists to pharmacies
  • Review the audit log to investigate any action taken by any user

Clinics API

Create and configure clinic locations, assign doctors, and control active status.

Pharmacies API

Provision pharmacy locations, assign managers, and set delivery fee parameters.

Users API

Onboard users, assign roles, and deactivate accounts when needed.

Admin API

Review the full immutable history of every critical action on the platform.

​
Platform statistics

The AdminStats object is returned by GET /api/v1/admin/stats and provides a real-time snapshot of the entire platform.
FieldDescription
total_clinicsTotal clinic locations registered
total_pharmaciesTotal pharmacy locations registered
total_doctorsRegistered doctor accounts
total_patientsRegistered patient accounts
total_appointmentsAppointments created across all time
total_prescriptionsPrescriptions issued across all time
total_salesCompleted pharmacy sales
total_delivery_ordersDelivery orders created
monthly_revenueAggregate sales revenue for the current calendar month
Additional breakdown fields provide per-status counts for appointments (appointments_by_status), prescriptions (prescriptions_by_status), and deliveries (deliveries_by_status), as well as recent_sales for a short-term activity indicator.

​
Managing clinics and pharmacies

Administrators are the only role that can create or deactivate clinic and pharmacy records. Deactivation (is_active: false) prevents new appointments and sales from being booked at that location without deleting historical data. 
// Create a clinic
POST /api/v1/clinics
{
  name: string;
  address: string;
  latitude: number;
  longitude: number;
  phone?: string;
}
Once a clinic is created, assign doctors to it by updating their DoctorProfile.clinic_id. Pharmacies follow the same pattern via PharmacyManagerProfile.pharmacy_id.

​
Audit log

Every significant action on the platform — creating prescriptions, fulfilling orders, modifying inventory, changing user roles — is recorded as an AuditLog entry. Entries are append-only and cannot be modified or deleted.
FieldDescription
user_idThe user who performed the action
user_nameDisplay name at the time of the action
actionVerb describing the action (e.g., "CREATE", "UPDATE", "DELETE")
entity_typeThe resource type affected (e.g., "Prescription", "User")
entity_idID of the specific record affected
detailsFree-text JSON snapshot of the change
ip_addressClient IP address for the request
created_atTimestamp of the action
GET /api/v1/admin/audit-logs?page=1&limit=50
The audit log is paginated. For compliance investigations, filter by entity_type and entity_id to trace the full lifecycle of a specific record.
Administrators have broad write access across all platform entities. Role assignments should follow the principle of least privilege — grant admin access only to personnel who require it for their responsibilities.

Build docs developers (and LLMs) love

Get started for freeTalk to us