API Changes & Deprecations

Detailed information on updates, breaking changes, and future deprecations for informed development.

API Access Token discontinuation

March 27, 2024

🚧

Effective October 31, 2024 the "API Access Token" authentication method will be discontinued.

From this date forward, we will exclusively support the Service User method for API authentication. This change is a step towards strengthening security measures and ensuring a more robust and reliable service for all our users.

From May 31, 2024 it will no longer be possible to create new API Tokens in the systems. However, you will still be able to manage the tokens that already in use, but only until October 31, 2024.

📣 Deprecation: Read my tasks

March 21, 2024

🚧

As of July 31st, 2024, we will be discontinuing the Read my tasks endpoint

This change comes as part of our ongoing efforts to enhance security and streamline our API authentication methods.
It may require some adjustments on your end, the good news is that we have already prepared an alternative endpoint that can replace the functionality of the discontinued endpoint: Read tasks of a specific employee This endpoint will provide you with similar functionality to the one you are currently using.

We recommend updating your integration to use this endpoint before the discontinuation date to avoid any disruption in your services.

📣 Deprecation: Read avatar for logged-in user

March 21, 2024

🚧

As of July 31st, 2024, we will be discontinuing the Read avatar for logged-in user endpoint

This change comes as part of our ongoing efforts to enhance security and streamline our API authentication methods.
It may require some adjustments on your end, the good news is that we have already prepared alternative endpoints that can replace the functionality of the discontinued endpoint: Read avatar for an employee ID , Read avatar for an employee email

We recommend updating your integration to use this endpoint before the discontinuation date to avoid any disruption in your services.

📣 Deprecation: Read all company employees and Read company employee by ID

August 15, 2023

🚧

The following endpoints are to be deprecated on March 31, 2024: Read all company employees and Read company employee by ID.

Note: As of April 2, 2024 the rate limits on these endpoints have been reduced from 100 to 70.

As part of our ongoing efforts to enhance performance, stability, and security, we're updating our APIs. We've introduced a Search API to replace the two GET endpoints for reading all company employees and employees by ID.

Using the new Search API you can retrieve specific employee data, designed for controlled access by Service Users only, offering enhanced security and stability.

Actions required:

• Familiarize yourself with the new Search API documentation.
• Review and update your API implementations to use the new endpoints.
• Transition to the new API in your production environment after thorough testing.

Benefits:

Faster Performance: Quicker responses with optimized speed.
Enhanced Stability: Improved service reliability.
Balanced Resource Use: Fair allocation and prevention of misuse.

Please ensure you update your integrations to avoid disruptions.