Version History

This article contains the version history of different HRCloud APIs and the changes with each version.

Version History

Aug 2019 (5.3)

  • Support POST task to create simple plain task

  • Support update picture for employee

April 2019 (5.2)

  • Support Applicant Create with resume and cover letter
  • Ability to upload resource that used to create applicant

October 2018 (5.1)

  • Support GET, POST attachment for an employee

  • Ability to upload or download multiple attachments

  • Support update employment status for employee

April 2017 (4.5)

  • The format for filtering by date has changed to yyyy-MM-ddTHH:mm:ss. For example:

    GET eq '2014-08-10T00:00:00'
  • Filtering by date now supports the not equal (neq) operator.

  • The format for filtering numeric fields has changed. You no longer need to quote the value. For example:

    GET gt 75000
  • When creating a new record with POST Employee, the format for lookup data is simplified. You now specify just the ID instead of a JSON object.

    For example:

    "xDepartmentLookup": "0ed631731310ac75410d314a1f8f0a57",
    "xEmploymentStatusLookup": "ecf26cfec9a1317fbc4587759ac78701",
    "xLocationLookup": "e7383c1aef35f315288aab5f6b980518",
    "xPositionLookup": "ce0de1aaaf1eb5fa923d05fc7761cb14",
  • The responses and error messages for bulk add and update have changed.

  • Employee responses have changed.

  • In associated lookup data, such as xLocationLookup, the url property is replaced with the two new properties __ObjectName and __Self.

    For example:

      "xLocationLookup": {
    "__ObjectName": "xLocation",
    "__Self": "",
    "Id": "5d03e0d8dd13c7ea",
    "xDescription": null,
    "xLocationCode": "LA",
    "xLocationName": "Los Angeles",
    "xRecordStatus": "Active"
  • You can retrieve a history of changes for rehires.

  • Successful POST and PUT requests now return only Status 200, instead of the entire entity.

February 2017 (4.3)

  • The API endpoint domain is changed to

June 2015 (3.4)

  • The POST and PUT methods support operations on multiple records using a single request.

May 2015 (3.3)

  • You can retrieve a history of changes for employment statussalariesbonuses, and positions.

  • Fields with currency are a JSON array with separate fields for amount and currency, for example:

      "xSalary": {
    "amount": "75,000.00",
    "currency": "USD"
  • During creation and updates, entities (and cloud objects) now validate values in single and multiple selection fields. For example, when updating the xCountry field of xEmployee with PUT, the values are constrained to those defined in the dashboard pulldown using Add Employee:

    Country Choices

    Values are case sensitive, for example India. A PUT example payload is next:

    "id": "8320fb07077a2935",
    "xCountry": "India"

May 2015 (3.2)

  • Support for POST and PUT for all entities.
  • Ability to limit fields in responses.
  • New ways to identify a record when updating a record with PUT.

April 2015 (3.1)

  • Endpoint domain changed, and version added and set to v1. The endpoint is now
  • New authentication method added using Customer_Key and Customer_Secret parameters.
  • Support for filtering responses using query parameters.
  • New position entity.
  • Only GET is supported for the 1.0 release. POST and PUT will be supported in a future release.

January 2015

Beta release.

September 2014

  • New Employee fields.
  • Creation and modification dates in responses.
  • Option to use username and password instead of APIKey for authentication.

August 2014

Initial beta release.