Obtener fichajes por servicio
Este endpoint devuelve los fichajes consolidados de un servicio dentro de un periodo concreto no superior a 31 días.
GET /api/v2/businesses/{businessId}/services/{serviceId}/clockguards?from={yyyy-MM-dd}&to={yyyy-MM-dd}Si los datos incluidos en la petición son correctos —tanto el businessId como el serviceId—, la respuesta contendrá los fichajes del servicio con toda la información definida para ellos.
Ejemplo de respuesta
[
{
"employeeId": "1006357",
"productId": "0001-GENERAL",
"locationId": "01",
"zoneId": "ZG",
"type": "WORK",
"checkIn": "2026-04-09T08:00:00.000Z",
"latIn": 37.389091,
"lonIn": -5.984459,
"deviceIn": "12345",
"checkOut": "2026-04-09T15:00:00.000Z",
"latOut": 37.389091,
"lonOut": -5.984459,
"deviceOut": "12345",
"comment": "Exit for lunch break.",
"orquestId": 380332115,
"data": {
"comments": [
{
"message": "Exit for lunch break.",
"created": "2026-04-07T14:51:22.943Z"
},
{
"message": "Inventory tasks at closing time.",
"created": "2026-04-07T14:52:09.140Z"
}
]
}
}
]Detalles
employeeId: identificador externo del empleado.
productId: identificador externo del producto vinculado al fichaje. Puede ser nulo si el fichaje se registró sin tarea en Orquest.
locationId: identificador externo de la tarea vinculada al fichaje. Puede ser nulo si el fichaje se registró sin tarea.
zoneId: identificador externo de la zona donde se realizó el fichaje. Puede ser nulo si el fichaje se registró sin zona.
type: tipo de actividad del fichaje (WORK, REST, OTHER).
checkIn: fecha y hora de entrada en UTC (yyyy-MM-ddTHH:mm:ss.SSSZ).
latIn: latitud del dispositivo en el momento del registro de entrada. Puede ser nulo.
lonIn: longitud del dispositivo en el momento del registro de entrada. Puede ser nulo.
deviceIn: identificador del dispositivo de fichaje en la entrada. Puede ser nulo.
checkOut: fecha y hora de salida en UTC (yyyy-MM-ddTHH:mm:ss.SSSZ).
latOut: latitud del dispositivo en el momento del registro de salida. Puede ser nulo.
lonOut: longitud del dispositivo en el momento del registro de salida. Puede ser nulo.
deviceOut: identificador del dispositivo de fichaje en la salida. Puede ser nulo.
comment: comentario del fichaje, si existe. En caso de que haya varios comentarios, en este campo aparecerá solo el primero, el resto aparecerán en el objeto comments.
orquestId: identificador interno del fichaje en Orquest.
data: información adicional del fichaje.
-
comments: lista de comentarios asociados al fichaje.
-
message: texto del comentario.
-
created: fecha y hora de creación del comentario en UTC (
yyyy-MM-ddTHH:mm:ss.SSSZ).
-
Aspectos que tener en cuenta
Esta petición devuelve solo los fichajes consolidados.
La API devuelve los datos en orden de registro, en UTC y en formato yyyy-MM-ddTHH:mm:ss.SSSZ.
La respuesta contendrá los datos desde la fecha indicada en el parámetro from hasta la fecha indicada en el parámetro to, incluyendo los de ambos días.
El intervalo máximo permitido para la consulta es de 31 días.
Si el período indicado en la URL es mayor, la solicitud devolverá un error 400 Bad Request, indicando en el mensaje The request exceded the maximum number of days allowed (31 days max).
Si no hay fichajes para el intervalo indicado en la URL, la petición devolverá un array vacío [].
Si el servicio especificado en la URL no existe en el negocio, la petición devolverá un error 404 Not Found indicando not exists.
Enlaces de interés
¿Qué es un fichaje?