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.

Clinics are the physical locations where doctors see patients. Every appointment and prescription is scoped to a clinic, making clinics a foundational resource in Oasis Liquido. The list endpoint supports proximity search via latitude and longitude, returning a distance_in_meters field so clients can sort by nearest location.

GET /api/v1/clinics

Return a list of active clinics. Pass lat and lng to enable proximity sorting; the response will include distance_in_meters for each clinic.

Query parameters

lat
number
Latitude of the user’s current position for proximity search.
lng
number
Longitude of the user’s current position for proximity search.
page
number
default:"1"
Page number.
limit
number
default:"20"
Results per page.

curl example

curl "http://localhost:8000/api/v1/clinics?lat=19.4326&lng=-99.1332" \
  --header "Authorization: Bearer <access_token>"

POST /api/v1/clinics

Create a new clinic record. Requires the admin role.

Request body

name
string
required
The clinic’s display name.
address
string
required
Full street address of the clinic.
latitude
number
required
Latitude coordinate (WGS 84).
longitude
number
required
Longitude coordinate (WGS 84).
phone
string
Optional contact phone number.

curl example

curl --request POST http://localhost:8000/api/v1/clinics \
  --header "Authorization: Bearer <access_token>" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Clínica Central Norte",
    "address": "Av. Insurgentes Sur 1234, CDMX",
    "latitude": 19.4326,
    "longitude": -99.1332,
    "phone": "+52 55 9876 5432"
  }'

GET /api/v1/clinics/:id

Retrieve a single clinic by its UUID. The response includes an array of the clinic’s associated doctors in the doctors field.

Path parameters

id
string
required
UUID of the clinic.

curl example

curl http://localhost:8000/api/v1/clinics/clinic-uuid-001 \
  --header "Authorization: Bearer <access_token>"

Clinic response fields

id
string
required
UUID of the clinic.
name
string
required
Clinic display name.
address
string
required
Full street address.
latitude
number
required
Latitude coordinate.
longitude
number
required
Longitude coordinate.
phone
string
Contact phone number.
is_active
boolean
required
Whether the clinic is currently active and accepting appointments.
distance_in_meters
number
Distance from the requested lat/lng coordinates. Only present when proximity parameters are supplied.
doctors
object[]
Array of doctor profiles associated with this clinic. Only present on the single-clinic endpoint.
created_at
string
required
ISO 8601 creation timestamp.
updated_at
string
required
ISO 8601 last-updated timestamp.

Build docs developers (and LLMs) love