Skip to main content
GET
Get Performance Review By Id

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token
string
required

Path Parameters

id
string<uuid>
required

Query Parameters

include_raw_data
boolean
default:false

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Example:

false

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

expand
string | null

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:

"manager[first_name,last_name]"

Response

Successful Response

The Performance Review object represents a single reviewer's assessment of an employee for a review cycle.

id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

modified_at
string<date-time>
required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

custom_fields
Custom Fields · object | null
required

The custom fields related to the model

Example:
employee
any | null
required

The employee this performance review is for.

Example:

"01a0b3cd-35a5-71df-8636-c86117dbf734"

reviewer
any | null
required

The employee who conducted this performance review. Null when type is EXTERNAL or unset.

Example:

"01a0b3cd-35a5-71df-8636-c86117dbf778"

type
enum<string>
required

The type of performance review. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:
SELF,
MANAGER,
PEER,
EXTERNAL
Example:

"MANAGER"

review_cycle_name
string | null
required

The name of the review cycle this performance review belongs to.

Example:

"Year End Review"

review_cycle_start_date
string | null
required

The day and time the review cycle started.

Example:

"2020-11-08T00:00:00Z"

review_cycle_end_date
string | null
required

The day and time the review cycle ended.

Example:

"2020-12-08T00:00:00Z"

comment
string | null
required

A free-text comment left on the performance review.

Example:

"Good Improvement"

status
enum<string>
required

The status of the performance review. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:
COMPLETED,
IN_PROGRESS
Example:

"COMPLETED"

rating
Rating · object | null
required

The overall rating given on this performance review, combining both the scale definition and the answer. Shape depends on the embedded 'type' key: when 'type' is 'NUMERIC', the object also carries 'min', 'max', 'step', and 'value'; when 'type' is 'SINGLE_SELECT', the object carries 'options' (the allowed labels) and 'value' (the selected label).

Example:
raw_data
Raw Data · object | null

This is the Raw data

Example: