Skip to main content

Kabal Attendance API

The Kabal Attendance API lets your own system read the attendance reports of your company: the same numbers the app shows under Reportes and puts in its Excel, computed at the moment you ask.

It is read-only. With a key you can read two reports and nothing else: no key can change a mark, an employee or a schedule, see a photo or reach another company.

What you can read​

ReportRouteWhat it is
SummaryGET /api/v1/reports/summary/One row per employee with the totals of a date range: expected days and minutes, late arrivals, early leaves, absences, worked, ordinary and extra minutes, days off.
DetailGET /api/v1/reports/daily/Every day of every employee in the range, with the shift that was expected, the marks the engine read and what it decided. Paginated by employee.

Both take the same filters as the reports page of the app (dates, sites, departments, positions, employees) and up to 92 days at a time.

Who it is for​

A company that runs its own payroll or HR system and wants Kabal's numbers in it without anyone copying an Excel. The typical use is a monthly close: on the first days of the month, the payroll system pulls the summary of the month that ended, computes what each person owes (expected_minutes - ordinary_minutes, see Reports) and applies its own rules, such as a bonus deduction for late arrivals.

It is built for that rhythm: a few calls per company per month, not continuous polling.

Who can use it​

The API comes with the paid plans; each plan says how many keys a company can have. An administrator of the company creates the key in the app and hands it to the developers. See Authentication.

Where to start​

  1. Quickstart: create a key and make your first call.
  2. Reports: what every column means and when to pull a month.
  3. Limits and Errors: what to expect when something is off.
  4. The Reference: every parameter and every field, generated from the API itself.