Employee data: Archived columns now hidden by default
Archived employee data table columns are now excluded from Public API responses unless specifically requested.
Why the change
Previously, employee table endpoints that fetch table data, such as the work table and other employee tables, used to include archived custom columns' data in their responses. This created confusion for developers who saw fields that do not exist for this table in the UI.
Now, all employee table data endpoints exclude archived columns by default. This makes responses cleaner and more intuitive, reducing the need to handle or filter out irrelevant fields when building or maintaining integrations.
What’s new
A new query parameter is now supported across all relevant employee table endpoints:
- Query param:
includeArchived(boolean, default: false)
Description: This parameter is designed to maintain backward compatibility. By default (false) archive columns will not be returned. Developers who want to include them should set the flag to true.
Affected endpoints
Single employee endpoints:
GET /people/{id}/workGET /people/{id}/employmentGET /people/{id}/lifecycleGET /people/{id}/salariesGET /people/{id}/equitiesGET /people/{id}/variableGET /people/{id}/training
Bulk endpoints:
GET /bulk/people/workGET /bulk/people/employmentGET /bulk/people/lifecycleGET /bulk/people/salariesPOST /people/actual-payments/search
✅ No action is required
No action is required unless your integration depends on data from archived columns.
If you do need the archived columns, you should update your API calls to include:includeArchived=true