Skip to navigation

Consultar horarios libres

Los horarios en que se puede reservar un servicio entre dos momentos: la misma respuesta que ve el cliente en la página pública. Resta lo ya reservado, el tiempo extra después de cada cita, la anticipación mínima y el límite diario de la cuenta. Hasta 31 días por consulta; por defecto, los próximos 7.

Sin staff_member_id, cada hora va a quien tenga menos citas ese día (“cualquiera”), así que cada hora aparece una vez. En una clase devuelve sus sesiones con class_session_id y seats_left.

Con booking_id en vez de service_id, devuelve las horas a las que esa cita se puede mover: sus mismos servicios y profesional, con su propia hora contada como libre. Es la respuesta que acepta POST /bookings/{booking_id}/reschedule.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Query parameters

service_idstringOptional

ID del servicio (booking.id del producto) o del producto. Requerido salvo con booking_id.

booking_idstringOptional
Las horas a las que se puede mover esta cita, en vez de las de un servicio.
staff_member_idstringOptional
Solo los horarios de esta persona.
fromstringOptional

Desde (fecha AAAA-MM-DD en la zona del negocio, o fecha y hora ISO 8601). Por defecto, ahora.

tostringOptional

Hasta (mismo formato). Máximo 31 días después de from.

Response

Horarios libres, en orden
starts_atdatetimeOptional
ends_atdatetimeOptional
staff_member_idstring or nullOptional

Quién atendería esa hora (o el instructor de la clase).

resource_idstring or nullOptional
class_session_idstring or nullOptional

En una clase, la sesión; reserva un lugar con este id.

seats_leftinteger or nullOptional
En una clase, los lugares que quedan.
segmentslist of objectsOptional

Errors

400
Bad Request Error
403
Forbidden Error