Saltar al contenido principal
GET
Devuelve los inicios de franja reservables de una única ubicación durante el periodo solicitado. Las franjas se generan a partir de open_hours de la ubicación, omitiendo las fechas bloqueadas globales o por ubicación y restando las citas de Aniva ya reservadas, de modo que el resultado refleja lo que tus pacientes pueden reservar realmente en el cliente. Requiere el alcance appointments_schedule. La ubicación también debe estar dentro del contexto de acceso de grupo de ubicaciones de tu clave de API.
Usa este endpoint en lugar de deducir la disponibilidad a partir del campo estático open_hours que devuelve Listar ubicaciones — solo este endpoint tiene en cuenta las reservas en tiempo real, las excepciones de horario por fecha y el preaviso mínimo de 12 horas en las ubicaciones gestionadas por Aniva. Todas las franjas devueltas aquí se pueden reservar tal cual.
Las respuestas incluyen Cache-Control: private, max-age=30, stale-while-revalidate=60, por lo que un navegador puede servir una respuesta en caché durante hasta ~30 segundos — una franja reservada en ese intervalo puede seguir apareciendo como reservable hasta la próxima actualización. Muestra también los conflictos en el momento de reservar.

Parámetros de ruta

string
requerido
Identificador de la ubicación (UUID). Usa el id de Listar ubicaciones.

Parámetros de consulta

string
Inicio inclusivo del periodo en formato YYYY-MM-DD (interpretado en timezone). Opcional. Por defecto es hoy cuando no se indica ninguna fecha, o end_date − 30 days cuando solo se indica end_date. Las fechas pasadas se ajustan silenciosamente a hoy.
string
Fin inclusivo del periodo en formato YYYY-MM-DD (interpretado en timezone). Opcional. Por defecto es hoy + 30 días cuando no se indica ninguna fecha, o start_date + 30 days cuando solo se indica start_date. Debe ser igual o posterior a start_date y estar dentro de los 90 días a partir de hoy.
string
Zona horaria IANA (p. ej., Europe/Berlin) utilizada para interpretar start_date / end_date y agrupar las franjas por fecha de calendario. Opcional — por defecto usa la propia zona horaria de la ubicación. Las horas de inicio de las franjas se devuelven siempre como instantes UTC (Z) y nunca cambian con este parámetro — la cuadrícula de franjas siempre se proyecta desde la zona horaria de la ubicación; el parámetro solo afecta a en qué día de calendario se agrupa una franja. Las entradas de día en la respuesta cubren exactamente start_date..end_date como días de calendario en esta zona horaria. Omítelo salvo que muestres el selector en otra zona horaria.

Respuesta

Si tiene éxito, la API devuelve 200 OK con un único objeto de disponibilidad.
string
requerido
Identificador de la ubicación reflejado.
string
requerido
Zona horaria IANA en la que se devuelve la respuesta (p. ej., Europe/Berlin) — refleja el parámetro de consulta timezone cuando se indica; de lo contrario, la propia zona horaria de la ubicación.
integer
Espaciado en minutos entre inicios consecutivos de franjas reservables. El intervalo de cuadrícula configurado en la ubicación — todas las franjas de availability caen en esta cuadrícula. Solo es null cuando la ubicación no tiene configuración de horarios. No es una ventana de duración de la cita: las reservas solapadas con horas de inicio distintas no entran en conflicto; solo las coincidencias exactas de hora de inicio cuentan para la concurrencia.
array
requerido
Franjas reservables por día. Los días sin franjas reservables se omiten para mantener la respuesta ligera. Cada entrada contiene:

Respuestas de error