Deprecation and Sunset Policies

Backward compatibility and sunset of old API endpoints

We make all efforts to never break the schema of existing, publicly available API endpoints. Any changes we’re introduce does not break the schema. If there are such changes, we will introduce a new version of an endpoint. Both versions are maintained and available to developers.

Deprecating Endpoints

When an endpoint is marked as deprecated this means SmartRecruiters will stop enhancing or adding new functionality to the deprecated endpoint. We will almost always provide a substitute endpoint or introduce a new endpoint that replaces the functionality of the deprecated endpoint. We will provide at least 10 months of lead time after an endpoint is deprecated to help customers transition to a different endpoint.

Sunsetting Endpoints

When an endpoint is sunset, it is no longer publicly available. Customers using this endpoint will no have access to the functionality.

Again, if we ever change plan to sunset any Public API endpoints, this will be announced to all impacted parties 10 months before the change is made with an appropriate steps to transition.

API Changelog

July 15th 2021


Cursor-based pagination is now available on both ListCandidates and ListJobs. We introduce the change because cursor-based pagination can help reduce latency in performance when users interact with more stability and reliability to SmartAPIs and SmartRecruiters systems

With an introduction of cursor-based pagination the offset-based pagination for these two endpoints will begin to sunset and will not be supported after the May 2022.

To ensure your application will continue to work after May 2022 and to take advantage on the improved performance cursor-based pagination has to offered, we recommend adjusting and updating your applications and integrations to the cursor-based pagination approach as soon as possible.

January 2018

Candidate API Updates

With the introduction of Parallel Applications functionality, we are deprecating Candidate API endpoints. If using any of the deprecated endpoints today, you must migrate to the corresponding alternative endpoints by November 29, 2018.

Read more about these updates: 

Deprecated endpoints

Alternative endpoints

PUT /candidates/{id}/onboardingStatus

PUT /candidates/{id}/jobs/{jobId}/onboardingStatus

GET /candidates/{id}/onboardingStatus

GET /candidates/{id}/jobs/{jobId}/onboardingStatus

GET /candidates/{id}/properties

GET /candidates/{id}/jobs/{jobId}/properties

PUT /candidates/{id}/properties/{propertyId}   

PUT /candidates/{id}/jobs/{jobId}/properties/{propertyId}

PUT /candidates/{id}/status

PUT /candidates/{id}/jobs/{jobId}/status

GET /candidates/{id}/status/history

GET /candidates/{id}/jobs/{jobId}/status/history

April 2018

Analytics API Deprecated

Endpoints in the Analytics API has been deprecated as of Apr. 26, 2018. These endpoints will function for existing integrations through Feb. 28, 2019, with the exception of the Interviews data service which will be made available to customers until April 30, 2019.

Customers should switch to the new Reporting API for any analytics integrations or to access reports as soon as possible.

Configuration API :/users endpoints moved to User API

We’ve extracted the users API endpoints originally contained in Configurations API into its own API now called User API. There should be no changes to any pre-existing functionality provided by those endpoints. We have added Access Group functionality to the User API.