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

• Getting access group by id
• Updating access group by id
• Deleting access group by id
• Creating new access group
• Listing access groups

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

• Get application configuration for posting
• Create a new candidate application

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

• Subscribe to a webhook

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

• Interview API

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.

References

• Self Schedules API
• Access scopes

Description

The Apply API now supports OAuth 2.0 as an authorization method. This update enhances the security and flexibility of integrations by allowing the use of OAuth 2.0 authorization flows for accessing these APIs.

OAuth 2.0 authorization is now available for the following endpoints:

1. Create a New Candidate Application
   POST https://api.smartrecruiters.com/postings/{uuid}/candidates
   Required OAuth 2.0 Scope: candidate_applications_manage

2. Get Application Configuration for Posting
   GET https://api.smartrecruiters.com/postings/{uuid}/configuration
   Required OAuth 2.0 Scope: candidate_applications_manage

3. Get Candidate Status
   GET https://api.smartrecruiters.com/postings/{uuid}/candidates/{candidateId}/status
   Required OAuth 2.0 Scope: candidate_applications_manage

The previously available authorization methods remain unchanged and supported, ensuring backward compatibility and no breaking changes.

Impact

This change introduces an additional, more secure way to authenticate requests to the Apply API. Existing authorization methods continue to function as before, ensuring no breaking changes. Adopting OAuth 2.0 is optional but recommended for improved security.

References

• Apply API Guide
• Create a New Candidate Application
• Get Application Configuration for Posting
• Get Candidate Status

Description

Apply-api now returns also applicationId when created a new candidate application.

Impact

This is additional information added to the response.
This change is backwards compatible and does not require any changes in the existing clients.

References

• Create a New Candidate Application endpoint

Description

Introducing a new way to authenticate with SmartRecruiters APIs using the client_secret_basic OAuth client authentication method.

This change enables the method based on the client ID and client secret, which are sent in the Authorization header of the token exchange request.
This method can be used for the OAuth 2.0. Client Credentials and Authorization Code grants.

Impact

This change provides an additional way to authenticate with SmartRecruiters APIs using the client_secret_basic method.
This change does not affect existing authentication methods.

References

• OAuth 2.0. Client Credentials grant
• OAuth 2.0. Authorization Code grant

Description

Introducing our new public API - Message Templates API.
This API enables you to manage message templates within SmartRecruiters, allowing you to create, update, delete, and retrieve templates.
To use this API, you will need the following access scopes: message_templates_read or message_templates_write.

Impact

The Message Templates API empowers you to handle message templates in SmartRecruiters, providing similar functionality as the UI.

References

• Message templates api
• Access scopes

Description

We have launched a new API endpoint that allows users to retrieve detailed job criteria for each position. This feature delivers structured information, including specific criteria, related questions, and the workflow steps assigned to each job.

• GET /reviews-api/v201910/jobs/{jobId}/criteria

Impact

This feature will help standardize interviews and improve hiring consistency.

References

• Get job criteria