Personal information
The Protime API allows you to retrieve personal data from the people collection.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoints
External references
The people collection supports predefined and custom external references. More information can be found on the External References Page.
| Type | External reference | Description |
|---|---|---|
| Predefined | @badge-number |
The badge number configured in Protime for the person. |
| Predefined | @employee-number |
The employee number configured in Protime for the person. |
| Custom | customPersonCode |
A custom key-value pair managed by the 3rd party. |
Usage in other collections
People external references can also be used in the following collections:
- Clockings
- Access clockings
- Absences
- Activity durations
- Counter instances
- Assignments
- Breaks
- Calculated totals
- Paid presences
- Work interruptions
- Contracts
- People’s historical fields
Predefined example:
?externalReferences=(people,@badge-number)
Custom example:
?externalReferences=(people,customPersonCode)