Retrieve a list
Introduction
You can retrieve a list of historical fields for the whole population.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/{HistoricalFieldCategoryIdentifier}-histories
URL parameters
This parameter needs to be filled in when calling this endpoint.
| Parameter | Description |
|---|---|
<HistoricalFieldCategoryIdentifier> |
The identifier of the historical field category (see table below). |
Response properties
This list of properties is returned by this endpoint.
| Property | Type | Description |
|---|---|---|
id |
integer | Internal unique identifier for the historical field record. |
changeVersion |
string | Property to indicate the order of changes. |
person.id |
integer | Internal unique identifier for the person. |
from |
string | Start date of the historical field record (YYYY-MM-DD). |
until |
string | End date of the historical field record (if applicable; until infinity if empty) (YYYY-MM-DD). |
historicalFieldCategory.id |
integer | Unique identifiers for the historical field catalog record. |
Historical field categories
The options for currently supported historical field categories are the following:
| Category | Identifier |
|---|---|
| departments | department |
| employers | employer |
| jobs | job |
| job categories | job-category |
| sectors | sector |
| work locations | work-location |
Filters
This endpoint does not require any filter parameters. It returns all historical fields in the system.
Note
People cannot be filtered in this endpoint. To retrieve historical fields for a specific person, use the single person endpoint.
External references
It’s possible to use predefined external references and custom external references. More information can be found on the External References Page
For a list of predefined external references, see the external reference options section.
Note
Check the query options below the endpoint on the Swagger page for the relevant external references.
Examples
Retrieve all department histories
Example to retrieve the history of departments for the whole population:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/department-histories
Retrieve all employer histories
Example to retrieve the history of employers for the whole population:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/employer-histories