Protime API documentation

Welcome to the Protime API documentation. This guide is designed to provide all the information you need to effectively use the Protime API.

Table of Contents

  1. General Specs
  2. Authentication
  3. Manipulating Resources
  4. Fetching Resources
  5. Delta
  6. Webhooks
  7. External References
  8. Responses
  9. Collections
  10. SwaggerUI

Release Notes

Our release notes of the Protime API can be found in the table below. Topics are summaries of significant releases and ordered from newest to oldest.

Topic Release Date Comments
Webhooks (access clockings) 15/07/2025 Webhooks support for access clockings
Access clockings 11/07/2025 Retrieving access clockings, with delta support
People contracts 11/07/2025 Retrieving contracts, with delta and webhooks support
Absence definitions 03/07/2025 Retrieving absence definitions, with delta and webhooks support
People 16/06/2025 Retrieving people and historical data, with delta and webhooks support on personal information
People historical catalogs 16/06/2025 Retrieving the full catalogs of the People historical fields (e.g. departments, employers etc.)
External references in Webhooks 10/06/2025 Support for external references in Webhooks for real-time integrations
Original time of day of clockings 07/05/2025 Original time of day of clockings added as property
Rename “badge” to “badge-number” 05/05/2025 Rename of the property “badge” to “badge-number” to reflect the software suite language better
Rename “persons” to “people” 05/05/2025 Rename of the property “persons” to “people” to reflect the software suite language better
Counter definitions 18/04/2025 Retrieving counter definitions, with delta and webhooks support
Counters 18/04/2025 Retrieving counter (instances) registered on the calendar of people, with delta and webhooks support
Delta (activity durations) 26/03/2025 Delta support for activity durations
Webhooks (clockings, activity durations) 25/03/2025 Webhooks support for clockings and activity durations
Activity durations 17/03/2025 Retrieving activity durations registered on the calendar of people
Delta (clockings) 11/03/2025 Delta support for clockings
External references 6/12/2024 Creating, updating and using 3rd party external references
Activity definitions 27/11/2024 Retrieving, creating and updating activity definitions
Clockings 04/08/2024 Retrieving and creating clockings (time, activity and reason kind)