performance
review

Retrieve a review

get/performance/{connection_id}/review/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/performance/{connection_id}/review/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Review

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

user_idstring required

the HR Employee being reviewed (reference to HrisEmployee)

reviewer_user_idstring

the HR Employee that wrote this review (reference to HrisEmployee)

cycle_idstring

pointer to the Performance Cycle object

template_identifierstring

id of the review template/form this review is based on

type'SELF' | 'MANAGER' | 'PEER' | 'UPWARD' | 'OTHER'
status'DRAFT' | 'IN_PROGRESS' | 'SUBMITTED' | 'COMPLETED' | 'SHARED' | 'ACKNOWLEDGED' | 'OTHER'
ratingnumber

the overall rating/score of this review

rating_maximumnumber

the maximum possible rating/score on the provider's scale

rating_descriptionstring

label of the rating on the provider's scale (e.g. "Exceeds expectations")

commentstring

the overall/summary comment of this review

is_acknowledgedboolean

whether the reviewee acknowledged this review

submitted_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

completed_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.