Skip to main content
GET
Get Performance Review Item By Id

Authorizations

Authorization
string
header
default:<BINDBEE_API_KEY>
required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token
string
header
default:<CONNECTOR_TOKEN>
required

The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.

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 Item object represents a single goal, competency, or other scored/commented item within a performance review.

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:
performance_review
any | null
required

The performance review this item belongs to.

Example:

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

name
string | null
required

The name of the performance review item.

Example:

"Double the sales"

type
string | null
required

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

Example:

"GOAL"

comment
string | null
required

A free-text comment left on the performance review item.

Example:

"Very close"

rating
Rating · object | null
required

The rating given to this performance review item, 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: