Reviews

A Review object can be created by a user against a candidate's application at any time during the hiring process in SmartRecruiters. The Reviews API enables you to create, retrieve, update and delete reviews of applications.

{
  "id": "string",
  "candidateId": "string",
  "jobId": "string",
  "reviewerId": "string",
  "overallRating": 0,
  "comment": "string",
  "createdOn": "2021-07-27T09:52:18.459Z",
  "updatedOn": "2021-07-27T09:52:18.459Z"
}

The review object

id string
Unique review identifier

candidateId string
Unique candidate identifier

jobId string
Unique job identifier

reviewerId string
Unique user identifier of the user who reviewed the application

overallRating integer
The rating of the candidate provided by the reviewer. The value should be a number between 1 and 5.

comment string
The content of the review on the candidate's application

createdOn date-time
The time that the review object was created. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.

updatedOn date-time
The latest time the overallRating or comment of the review object is updated. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.