v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBGet Changed Employee Table Data
Returns table data for employees that have changed since the given timestamp. This is an optimization to avoid downloading all table data for all employees. It operates on an employee-last-changed-timestamp, which means that a change in ANY field in the employee record will cause ALL of that employee's table rows to show up via this API. The response includes the table rows grouped by employee ID with their last-changed timestamps.
OAuth Scopes: employee, employee:assets, employee:compensation, employee:custom_fields, employee:custom_fields_encrypted, employee:education, employee:emergency_contacts, employee:job, sensitive_employee:creditcards
Path parameters
The API name of an employee table. Standard table names: jobInfo, jobInformation, compensation, employmentStatus, contacts, emergencyContacts, dependents, earnings, bonus, commission, benefit_class, employeeVisas, employeeEducation, employeePassports, employeeDriverLicenses, employeeCertifications, employeeStockOptions, employeeAssets, employeeCreditCards, employeeCovidTests, employeeCovidVaccinations, employeeCovidVaccinationExemptions, employeeCovidExposures, employeeEquityGrants, levelsAndBands, employeeProjectPayRates. Custom company-defined tables also accepted — they use a numeric suffix (e.g., custom1, custom42). Use the list-tabular-fields tool (GET /api/v1/meta/tables) to discover custom table names for a specific company.
The API name of the table to retrieve changed data for. See the TableName schema for valid standard values; custom tables use a custom prefix. Use GET /api/v1/meta/tables to discover the complete list.
Query parameters
ISO 8601 timestamp (URL-encoded). Only employees changed since this timestamp will be returned.
Response
Changed table data for the specified table, grouped by employee ID.