Changelog

The latest stable version is v1.7.

2025-10-20
New Version: v1.9
  • The GET /{appType}/{appId}/comms operation no longer returns all communications for the candidate, but only those related to the application.
  • Fixed an issue where requesting resources with &rich_txt_fmt=html would incorrectly stringify all the values in the response, including numeric values, booleans, and nulls. Now only string values are affected.
2025-04-01
New Version: v1.8 Creating a new candidate with the POST /candidates operation no longer initiates the account activation process that sends out an email prompting the user to choose a password.
2024-10-03
New Version: v1.7 Updated versions of GET history endpoints, */history. New JSON payload format; added a new type property, standard API date format (ISO8601) for the date property, the has_more property is now of type boolean, not number or string.
2024-06-13
New Version: v1.6 Updated versions of POST application copy endpoints, applications/<id>/copy. New JSON payload format; An opp_id property instead of the vacancy_id, added a run_config_autoscoring property.
2024-02-07
New Version: v1.5 Updated versions of GET systems endpoints. New JSON payload format, the domain property to be a fully qualified domain name.
2023-10-04
New version: v1.4 Updated endpoint names for the different types of ‘applications’ to be more consistent:
  • applications -> vacancy_applications
  • event_registrations -> event_applications

There are no plans to remove the old endpoints but the new endpoint names will now be used in other responses such as api/v1/api/quick_search.

2021-09-16
New Version: v1.3 Updated versions of POST bulk_form_values endpoints applications/bulk_form_values, vacancies/bulk_form_values. New JSON payload format, no longer multipart form.
2021-08-19
New Version: v1.2 Updated versions of POST form_value endpoints applications/<id>/form_values, vacancies/<id>/form_values. New more documentable serialisation format, atomic - no partial updates, more data types handled, improved validation.