Historical fields
The API provides access to historical fields. These track the history of organizational assignments such as departments, employers, jobs, job categories, sectors, and work locations for people over time.
Tip
Check the Swagger page for more technical information on the endpoints.
Historical field categories
The following categories can be used when retrieving historical fields:
- Departments (
department-histories) - Employers (
employer-histories) - Jobs (
job-histories) - Job categories (
job-category-histories) - Sectors (
sector-histories) - Work locations (
work-location-histories)
Endpoints
External references
The historical field collections themselves do not carry external references. Each endpoint accepts references for the people collection and for the collection of the referenced entity. More information can be found on the External References Page.
| History type | Supported collections | Predefined | Custom |
|---|---|---|---|
department-histories |
people, departments |
@badge-number, @employee-number |
Supported |
employer-histories |
people, employers |
@badge-number, @employee-number |
Supported |
job-histories |
people, jobs |
@badge-number, @employee-number |
Supported |
job-category-histories |
people, job-categories |
@badge-number, @employee-number |
Supported |
sector-histories |
people, sectors |
@badge-number, @employee-number |
Supported |
work-location-histories |
people, work-locations |
@badge-number, @employee-number |
Supported |
Predefined references are available for the people collection only. The entity collections (departments, employers, jobs, job-categories, sectors, work-locations) support custom references.
Example (list endpoint):
?externalReferences=(departments,customDepartmentCode)
Example (per-person endpoint):
?externalReferences=(people,@badge-number)(departments,customDepartmentCode)