Description

The Job Board API feed was updated to expose job ad video URLs to external users via a new optional videoUrls field in feed responses.

Addition in the OpenAPI specification:

        "jobAd" : {
          "$ref" : "FeedJobAdDetails"
+       },
+       "videoUrls" : {
+         "type" : "array",
+         "description" : "Video URLs associated with the job ad. Returned as stored - query parameters, if present, are preserved.",
+         "items" : {
+           "type" : "string"
+         }
        }

URLs are validated and returned as stored - clients are responsible for how they embed or further process these URLs.

Impact

This change is backwards compatible.

Existing integrations remain valid. Clients consuming the Job Board API feed may start receiving a videoUrls array for job ads that have associated videos.

When no videos are available, the field is omitted from the response.

References

• Job Board API

Description

The OpenAPI specification was updated to document a 422 Unprocessable Entity response with compensation-related error codes for requests that have issues with compensation information based on company configuration.

Addition in the OpenAPI specification for affected paths:

             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+        '422':
+          description: |
+            with codes
+            * **COMPENSATION_REQUIRED** – compensation is required by company configuration but is missing or incomplete.
+            * **COMPENSATION_HIDDEN** – compensation should not be provided when company configuration requires it to be hidden.
+            * **COMPENSATION_INVALID_CURRENCY** – the currency code provided is invalid or not supported.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'

This 422 response is documented for the following endpoints:

• Postings
  • POST /jobs/{id}/jobads/{jobAdId}/postings – Publish a job ad
• Publication
  • POST /jobs/{id}/publication – Publish default job ad

Impact

The change is backwards compatible unless an admin changes salary transparency or compensation display configuration. When compensation is required by company configuration, clients that publish jobs or job ads without compensation will receive a 422 response with code COMPENSATION_REQUIRED. When compensation must be hidden, providing compensation will return COMPENSATION_HIDDEN. Invalid currency codes will return COMPENSATION_INVALID_CURRENCY. Valid payloads are unchanged.

References

• Jobs API

Description

A new optional response field aiSettings has been added to the Applications API. This field is intended to contain AI-related configuration. Currently, it contains aiDisclosureLabel, which informs candidates that the information they provide may be processed by AI.

The field is currently displayed for accounts in the sandbox environment of customers who have access to Winston Match. The field will be available for all accounts starting April 14, 2026. We suggest displaying the AI Disclosure if you are using the AI-based solutions provided by SmartRecruiters, which process applicant information as part of the hiring process.

Response example:

"aiSettings": {
  "aiDisclosureLabel": "Your application data may be processed by AI."
}

Impact

This change is backward-compatible. The parameter is optional; existing integrations do not need to be updated. However, customers using Winston Match should adopt their career site to display the AI disclosure, provided in the aiSettings.aiDisclosureLabel field of the GET /postings/:uuid/configuration response.

References

• Get application configuration for posting
• Get Application Screening Questions and Privacy Policies

Description

We have introduced new endpoints in the Job Applications API to support consent request workflows for job applications. These enhancements enable organizations to request and track candidate consent in an application context across various data processing scopes, supporting both single and separated consent approaches, in line with privacy regulations.

It is now possible to retrieve all consent decisions for a specific application, allowing external systems and custom candidate flows to leverage a unified, application-level consent model.

The new functionality is available to all users in the sandbox environment and is ready for immediate use. We encourage all clients to leverage these endpoints to streamline and strengthen their consent management processes.

Impact

This change introduces new, non-breaking features to the Job Applications API. There are no breaking changes to existing integrations.

Migration

To take advantage of the new capabilities, we recommend migrating from the previous endpoints to the new ones:

• Replace: Candidates API - Candidates consent decisions → Job Applications API - Get consent decisions
• Replace: Candidates API - Request consent from multiple candidates → Job Applications API - Request consent for a job application

The new endpoints provide a consistent, application-level consent model and facilitate integration with external systems and custom candidate flows.

References

• Job Applications API - Get consent decisions
• Job Applications API - Request consent for a job application

Description

A new optional query parameter hiringTeamMemberId has been added to the Search jobs API. It allows you to filter jobs by hiring team members in any role. Pass one or more user identifiers to restrict results to jobs where any of the provided users is on the job's hiring team.

Impact

This change is backward compatible. The parameter is optional; existing integrations do not need to be updated. Clients can adopt the new filter when they need to narrow search results by hiring team membership.

References

• Search jobs API

Description

Search jobs API now supports filtering by multiple job statuses.

New parameter: statuses - Pass one or more job states (e.g. ?statuses=SOURCING&statuses=FILLED). Results include jobs in any of the given states (OR). Allowed values: CREATED, SOURCING, FILLED, INTERVIEW, OFFER, CANCELLED, ON_HOLD (uppercase). Use statuses for all new integrations.

Parameter status (single value) is deprecated. It remains supported for backward compatibility but should not be used for new development. Prefer statuses instead (e.g. ?statuses=SOURCING for a single value). When both status and statuses are present, statuses is used and status is ignored.

Impact

The status parameter is deprecated; use statuses for new and updated integrations. Existing clients using only status continue to work; no immediate change is required. We recommend migrating to statuses when convenient. No breaking change.

References

• Search jobs

Description

The user logout flow has been enhanced with audit events sent during the process.

Impact

This enhancement is backward-compatible and does not require any changes to existing client implementations.

References

• Audit API

Description

The Audit API has been enhanced to provide insights into updates of Web SSO configurations. The new event WEB_SSO_CONFIGURATION_UPDATED is triggered when a Web SSO configuration is updated. The event context provides a previous and current snapshot, detailing the state of the configuration prior to and following the update.

Impact

These changes are backward-compatible and introduce a new event type that can be monitored. Existing integrations will not be affected. These events provide greater visibility into administrative changes.

References

• Audit API

Description

Extending Configuration API by adding optional field: key to the create job property endpoint request body:

• POST /configuration/job-properties

Impact

This enhancement is backward-compatible and does not require any changes to existing client implementations. This will allow clients to set a custom key for job properties during their creation. If the key is not provided, the system will auto-generate one as per existing behavior.

References

• Configuration API

Description

A new Notifications API has been introduced to manage notification preferences in SmartRecruiters. This API allows you to configure how and when notifications are delivered to employees and set global notification preferences for your organization.

The API provides the following capabilities:

• Employee Preferences Management: Get, save, and update individual employee notification preferences for specific channels (EMAIL, SLACK, TEAMS). You can manage preferences for different hiring team roles and notification types.
• Global Preferences Management: Configure organization-wide notification preferences that apply to all users. You can choose to save preferences while preserving individual user settings, or override all individual preferences.
• Notification Types Discovery: Retrieve all supported notification types along with the applicable hiring team roles and delivery channels for each type.
• Bulk Operations: Activate or deactivate multiple notification preferences in a single request for both employee and global preferences.

The API supports OAuth2 authentication with the following scopes:

• notification_preferences:read - Read access to notification preferences
• notification_preferences:manage - Write access to notification preferences

Impact

This is a new API addition and does not affect any existing APIs or integrations.

References

• Notifications API Documentation