Description
Extending Self Scheduling API by adding endpoints to:
- retrieve available slots for interview
- create interview at a specific slot
- update interview at a specific slot
To use this API, you will need the following access scopes: self_schedules_read or self_schedules_manage.
Impact
The Self Schedule API allows to create, delete and search for interview self schedules, providing similar functionality as the UI.
Self scheduling allows candidate to pick up the time slot for the interview, and interview would be created as a result.
References
Description
Assessment API(v1) endpoints, that were officially sunset on June 10th 2024, are removed. This API was replaced by the Assessment API(2021).
Removed endpoints:
GET https://api.smartrecruiters.com/v1/assessmentsPOST https://api.smartrecruiters.com/v1/assessmentsPOST https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}/rejectPOST https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}/completePOST https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}/acceptGET https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}GET https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}/commentsPOST https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}/commentsGET https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}/comments/{commentId}
Related Offers API(v1) endpoints are also removed:
POST https://api.smartrecruiters.com/v1/offersGET https://api.smartrecruiters.com/v1/offers/{offerId}POST https://api.smartrecruiters.com/v1/offers/{offerId}POST https://api.smartrecruiters.com/v1/offers/{offerId}/withdrawPOST https://api.smartrecruiters.com/v1/offers/{offerId}/submit
with the exception of GET https://api.smartrecruiters.com/v1/offers, which is not removed.
Impact
This change is not backward-compatible.
All customers using the Assessment API(v1) and Offers API (v1) no longer have access to these APIs.
All integrations still using these APIs are affected.
References
Description
Introducing new public API - Interview Templates API.
This API allows to create, update, delete and search for interview and job interview templates.
It is also responsible for managing the interviewer scheduling preferences.
To use this API, you need to be granted the following access scopes: interview_templates_read, interview_templates_manage, schedule_preferences_read.
Impact
The Interview Templates API empowers users to interact with the interview / job interview templates and interview scheduling preferences.
There are neither breaking changes in the existing API nor any migration steps required.
References
Description
Introducing the General Partner Integration flow.
The General Partner Integration flow is a new approach to integrating partners and customers.
It follows the OAuth 2.0 protocol and uses the Client Credentials flow to securely exchange data with integrated systems.
Impact
This change is backward-compatible and does not require any modifications to existing clients.
References
Description
Introducing new endpoints for managing Access Groups in Configuration API. They allow to read, update, create, delete, and list Access Groups details and configuration.
These are the new access groups endpoints:
- getting list of access groups:
GET /configuration/access-groups - creating new access group:
POST /configuration/access-groups - getting access group details:
GET /configuration/access-groups/{accessGroupId} - updating access group details:
PUT /configuration/access-groups/{accessGroupId} - deleting access group:
DELETE /configuration/access-groups/{accessGroupId}
Impact
New set of endpoints gives API users Access Groups management capabilities available so far only on the UI.
This enhancement is backward-compatible and does not require any changes to existing client implementations.
References
Description
The response of GET /postings/{uuid}/configuration now includes two new properties: consentSettings and companyImprintUrl. Consent settings contains list of consent scopes with details. Each scope is described by its scope key, flag indicating whether scope acceptance is required and a consent text statement (as configured in company policy settings).
If there is no customer privacy policy configured, the scopes of consentSettings will be an empty list.
Impact
This is a non-breaking change, as it only enhances the response of a single endpoint.
Consumers of POST /postings/{uuid}/candidates can now analyze the required data there without additional checks of the compliance configuration.
References
Description
This change adds an optional scope property to the callbackAuthentication object of type oauth2 in the POST /webhooks-api/v201907/subscriptions request body params.
It allows customers to define scopes that will be passed to the token service used by SmartRecruiters to obtain an access token for the webhook callback URL.
Impact
This is a non-breaking change, as it only adds a parameter to the request of a single endpoint.
Clients do not need to update or modify anything in their existing codebase.
References
Description
The response of the GET /interviews/{interviewId} and GET /interviews endpoints now includes a new field: refId. For interviews created via Self Schedule, the refId corresponds to the Self Schedule ID.
Impact
This enhancement is backward-compatible and does not require any changes to existing client implementations.
References
Description
Introducing new public API - Self Scheduling API.
This API allows to manage interview self schedules in SmartRecruiters.
To use this API, you will need the following access scopes: self_schedules_read or self_schedules_manage.
Impact
The Self Schedule API allows to create, delete and search for interview self schedules, providing similar functionality as the UI.
Self scheduling allows candidate to pick up the time slot for the interview, and interview would be created as a result.