Skip to navigation
Using the API

Endpoint differences

Endpoints were added over time and do not all filter, page or select staff the same way. This page lists every difference in one place. The API itself is unchanged.

Filters and page sizes

EndpointsStaff filterBranch / department filterPage size (default / max)
List Daily Attendance, List Attendance Muster, List Punchessalarybox_ids, comma-separatedbranch_names, department_names, comma-separated names500 / 500
List Leave Balancessalarybox_ids, comma-separatednone500 / 500
List Attendance Timesheets, List Staff Schedules, List Staff Attendance Settingssalarybox_ids, repeatablebranch_names, department_names, repeatable exact names500 / 500
List Staff, List Inactive Staffone salarybox_id, plus employee_id, name, job_title, phone_numberbranches, departments, repeatable IDs from List Branches / List Departments; comma-separated values are rejected with 40025 / 500
List Staff CTC, List Salary Breakdowns, List Salary Paid, List Advances Paid, List Payroll History, List Payroll Payments, List Tax Declarations, List Late Fine Settings, List Early Leaving Fine Settings, List Overtime Settingssalarybox_ids, repeatablenone50 / 50
List Wallet Ledgernonenone200 / 200
List CRM Meetings, List CRM Tripssalarybox_ids, repeatable, at most 10none25 / 25
List CRM Trip Timelinesalarybox_ids, repeatable, required, 1 to 10none25 / 25
Get Staff Member, Get Staff Overtimeone salarybox_id, requirednonenot paginated
List Staff Location Historyone salarybox_id, requirednone500 / 500
All other list endpointssalarybox_ids, repeatable, where offerednone500 / 500

Not paginated: Get Company Profile, Get Company Subscription, Get Payroll Settings, Get Payroll Summary, Get Staff Member, Get Staff Overtime, List Leave Approval Flows and List Reimbursement Approval Flows.

Pages past the end

Most endpoints return 404 "Invalid page." for a page past the last one. These return 200 with an empty data instead, and treat a missing, zero or non-numeric page as page 1: List Staff, List Inactive Staff, List Staff CTC, List Salary Paid and List Advances Paid.

Date ranges

Longest rangeEndpoints
31 daysList Attendance Timesheets, List CRM Meetings, List CRM Trips, List CRM Trip Timeline
60 daysList Daily Attendance, List Attendance Muster, List Punches, List Staff Schedules
12 monthsList Payroll History
366 daysList Payroll Payments
under 366 daysList Wallet Ledger
one monthList Staff Notes, Get Staff Overtime, List Staff CTC, List Salary Breakdowns, List Salary Paid, List Advances Paid

Who is included

Inactive staffEndpoints
Only inactive staffList Inactive Staff
IncludedList Employment History, List Staff Notes, List Payroll History, List Payroll Payments, List Tax Declarations, Get Staff Overtime, List Staff Location History, List Location Tracking Requests, List CRM Meetings, List CRM Trips, List CRM Trip Timeline
Included if they left during the monthList Salary Breakdowns
Not includedList Staff, Get Staff Member, List Add-on Permissions, List Custom Fields, List Attendance Timesheets, List Staff Schedules, List Staff Attendance Settings, List Late Fine Settings, List Early Leaving Fine Settings, List Overtime Settings, List Leave Requests, List Reimbursement Requests, List Device Mapping Requests, List Latest Staff Locations

Grouped endpoints list only staff who have something to show (List Employment History, List Staff Notes, List Payroll Payments, List Latest Staff Locations). The CRM, timesheet, schedule and settings endpoints list every included staff member, even with nothing in the range.