Review data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
user_id | string | Yes | the HR Employee being reviewed (reference to HrisEmployee) |
reviewer_user_id | string | No | the HR Employee that wrote this review (reference to HrisEmployee) |
cycle_id | string | No | pointer to the Performance Cycle object |
template_identifier | string | No | id of the review template/form this review is based on |
type | enum | No | Values: SELF, MANAGER, PEER, UPWARD, OTHER |
status | enum | No | Values: DRAFT, IN_PROGRESS, SUBMITTED, COMPLETED, SHARED, ACKNOWLEDGED, OTHER |
rating | number | No | the overall rating/score of this review |
rating_maximum | number | No | the maximum possible rating/score on the provider's scale |
rating_description | string | No | label of the rating on the provider's scale (e.g. "Exceeds expectations") |
comment | string | No | the overall/summary comment of this review |
questions | PerformanceReviewQuestion[] | No | |
questions[].question | string | Yes | |
questions[].description | string | No | |
questions[].type | enum | No | Values: TEXT, SINGLE_SELECT, MULTI_SELECT, RATING, OTHER |
questions[].answers | string[] | No | all answer values; single-answer questions have one element |
is_acknowledged | boolean | No | whether the reviewee acknowledged this review |
submitted_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
completed_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metadata | PerformanceMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Are we missing anything? Let us know
Was this page helpful?