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
Historical field collections support custom external references on their respective collections. More information can be found on the External References Page.
| Collection | Type | Notes |
|---|---|---|
department-histories |
Custom | The people collection is only available on the per-person endpoint. |
employer-histories |
Custom | The people collection is only available on the per-person endpoint. |
job-histories |
Custom | The people collection is only available on the per-person endpoint. |
job-category-histories |
Custom | The people collection is only available on the per-person endpoint. |
sector-histories |
Custom | The people collection is only available on the per-person endpoint. |
work-location-histories |
Custom | The people collection is only available on the per-person endpoint. |
The people collection (@badge-number, @employee-number) is additionally supported on the per-person GET endpoint.
Example (list endpoint):
?externalReferences=(department-histories,customDeptCode)
Example (per-person endpoint):
?externalReferences=(people,@badge-number)(department-histories,customDeptCode)