v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Change Tracking

Public API

Get Changed Employee IDs

Returns a list of employee IDs that have changed since the given timestamp. This allows for efficient syncing of employee data — rather than downloading all employees, only those that have changed are returned. A change in ANY individual field in the employee record, as well as any change to the employment status, job info, or compensation tables, will cause that employee to be returned. Each entry includes the employee ID, the type of change (Inserted, Updated, or Deleted), and the last-changed timestamp.

OAuth Scopes: public.integration, public.user

get/api/v1/employees/changed

Query parameters

sincestring date-time required

ISO 8601 timestamp (URL-encoded). Only employees changed since this timestamp will be returned.

type'inserted' | 'updated' | 'deleted' | 'all'

Filter by change type. If omitted, all change types are returned.

Response

The latest change timestamp in the result set and a map of employees changed since the given timestamp.

lateststring date-time required

The latest last-changed timestamp among the returned employees.

employeesobject required

Map of employee IDs to change metadata for each changed employee.