Retrieve a person

Introduction

You can retrieve personal data by the internal ID or an external reference using the GET call. Internal IDs for people can be found by listing all people using the GET collection endpoint.

Endpoint details

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people/{PersonReference}

URL parameters

This parameter needs to be filled in when calling this endpoint.

Parameter	Description
<PersonReference>	The internal ID or external reference of the person.

Response properties

This list of properties is returned by this endpoint.

Property	Type	Description
id	integer	Internal unique identifier for the person.
changeVersion	string	Property to indicate the order of changes.
periodClosingDate	string	Date of the period closing, used to lock the calendar.
hourlyRateCurrencyDefinition.id	integer	Internal unique identifier for the hourly rate currency.
advanceCurrencyDefinition.id	integer	Internal unique identifier for the advance currency.
lastName	string	Last name of the person.
firstName	string	First name of the person.
initials	string	Initials of the person.
telephone	string	Telephone number.
mobile	string	Mobile phone number.
email	string	Email address.
address	string	Street address with the number.
postalCode	string	Postal code.
town	string	Town or city.
countryIsoCode	string	ISO code of the country.
nationalityIsoCode	string	ISO code of the nationality.
sex	string	Sex of the person (Unknown, Female, Male, Other).
maritalStatus	string	Marital status (Unknown, Single, Married, Widow, Widower, Divorced, LivingTogether).
birthDate	string	Birth date of the person (YYYY-MM-DD).
placeOfBirth	string	Place of birth.
drivingLicense	string	Driving license number.
registerNumber	string	Register number.
passportNumber	string	Passport number.
socialSecurityNumber	string	Social security number.
bankAccount	string	Bank account number.
inServiceDate	string	Date when the person entered service (YYYY-MM-DD).
outOfServiceDate	string	Date when the person stopped service (YYYY-MM-DD). To infinity if empty.
wtdStartDate	string	WTD start date (YYYY-MM-DD).
employeeNumber	string	Employee number.
payGroup	string	Pay group of the person.
hourlyRate	number	Hourly rate.
maxAdvance	number	Maximum advance allowed.
terminalGroup.id	integer	Internal unique identifier for the terminal group the person is linked to.
badgeNumber	string	Badge number of the person. Needs to be unique.
pinCode	integer	PIN code.
terminalLanguageISOCode	string	ISO code of the terminal language for this person.

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.

Examples

Retrieving a person by internal ID

Example with internal ID 8526:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people/8526

With predefined external reference - badge number

Example with badge number6526:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people/6526?externalReferences=(people,@badge-number)

With predefined external reference - employee number

Example with employee number 005325:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people/005325?externalReferences=(people,@employee-number)