NominexDocs
Referencia de la APIChecadas

Listar

Consulta las checadas registradas en tu organización.

Descripcion general

Este endpoint devuelve un listado paginado de las checadas (marcas de entrada y salida) registradas en tu organización, sin importar por dónde entraron: la API pública, o la captura masiva estilo Excel dentro de la plataforma.

Cada checada guarda dos tiempos: timestamp, el instante exacto de la marca en UTC, y local_date, el día natural al que pertenece según la zona horaria de asistencia de la organización. local_date es el día que agrupa la derivación de retardos, y es el campo sobre el que filtran from y to.

Los resultados se ordenan del día más reciente al más antiguo.

Requiere que la API key tenga el permiso Listar checadas.

Endpoint

GEThttps://app.integranom.com/api/v1/time-clock-events

Consulta multiples checadas


Devuelve todas las checadas de la organización, paginadas de 20 en 20.

Fíjate en la segunda fila del ejemplo: la marca ocurrió a las 00:02 UTC del 5 de junio, pero su local_date es el 4 de junio — en la zona horaria de la organización todavía era el día anterior. Siempre filtra por local_date (con from / to), nunca por la hora UTC.

Query params

ParametroTipoDefaultDescripcion
pageinteger ≥ 11Página solicitada. El tamaño de página es fijo en 20.
employee_numberinteger-Filtra las checadas de un solo empleado.
fromstring (YYYY-MM-DD)-Incluye checadas con local_date mayor o igual a esta.
tostring (YYYY-MM-DD)-Incluye checadas con local_date menor o igual a esta.

Filtra por empleado y periodo


employee_number, from y to se combinan. El ejemplo trae las checadas del empleado 1 durante junio.

La segunda fila llegó por la captura masiva estilo Excel dentro de la plataforma (source: "excel"), no por un dispositivo: por eso no trae device_id. Todas las fuentes conviven en el mismo listado.

Campos de cada fila

CampoTipoDescripcion
timestampstring (ISO 8601, UTC)Instante exacto de la marca.
local_datestring (YYYY-MM-DD)Día natural de la marca en la zona horaria de asistencia de la organización. Es el día que agrupa la derivación de retardos.
direction"in" | "out" | nullDirección declarada por el dispositivo. null cuando no la envía.
source"api" | "excel" | "qr"Por dónde entró: la API pública, la captura masiva estilo Excel, o el escaneo de un código QR de checada desde la app.
device_idstring | nullIdentificador del dispositivo que envió la marca. null en las marcas que no vienen de un dispositivo, como las de source: "excel" y source: "qr".
employee_numberintegerNúmero del empleado dentro de la organización.
employee_namestringNombre completo del empleado.
legal_entity_numberintegerRazón social del empleo.
legal_entity_namestringNombre de la razón social.
created_atstring (ISO 8601)Cuándo se registró la marca en la plataforma.

Errores

StatusCausa
400Valor inválido en algún filtro (employee_number no entero, from / to con formato incorrecto, o to anterior a from).
401API key ausente o inválida.
403La API key no tiene el permiso Listar checadas.
Abrir Nominex