Review API Reference

Introduction

The PerformYard Review API allows customers to programmatically retrieve and manage data related to reviews defined in PerformYard. The API endpoints will let you:

Retrieve a list of Review Templates with the ability to sort, filter, and paginate results.
Create a review for an employee based on an existing Review Template.

Requirements

Calling these API endpoints requires an API Key and API ID. See Getting Started with PerformYard API for details on creating API keys and API Authentication for authentication flow.

Retrieve All Review Templates

GET https://api.talent.performyard.com/v1/review-templates

Returns a list review templates.

Query Parameters

limit integer

The number of review templates to be returned in a single API Request.

Default: 200

Minimum: 5

Maximum: 200

offset integer

Used to paginate through the list of review templates. Can be combined with limit.

Default: 0

Increment the value by one to fetch subsequent pages (1 for the second page, 2 for the third, etc.).

sort string

Order in which to return the list of employees.

Allowed Values: asc(FIELD_NAME) desc(FIELD_NAME)

Allowed Field Names: name last_updated_date

name string

Filter the returned review templates by a specific name.

Accepts only a single string value. Case sensitive.

CURL Example

curl --location 'https://api.talent.performyard.com/v1/review-templates?limit=100&offset=0&sort=desc(name)' \
--header 'Accept: application/json' \
--header 'x-api-id: {{X-API-ID}}' \
--header 'x-api-key: {{X-API-KEY}}'

Response (200)

{
  "reviewTemplates": [
    {
      "id": "<string>",
      "name": "<string>",
      "last_updated": "<string>",
      "number_of_forms": <integer>
    },
    ....
  ]
}

Create Review for a Subject

POST https://api.talent.performyard.com/v1/reviews

Create a review for an employee based on a review template.

Request Body Parameters

subjectId string required

The employee the review is being created for.

templateId string required

The template to use when creating the review.

startDate string required

The date of when the review should start.

Allowed Formats: YYYY-MM-DD

startTime enum

The time when the review should start.

Default value is based on company default review time. Timezone is based on company timezone.

Allowed Values: midnight 9am noon 5pm

Accepts only a single string value.

Request Body Format

{
  "subjectId": "<string>",
  "templateId": "<string>",
  "startDate": "<string>",
  "startTime": "<string>"
}

CURL Example

curl --location 'POST https://api.talent.performyard.com/v1/reviews' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-id: {{X-API-ID}}' \
--header 'x-api-key: {{X-API-KEY}}' \
--data '
  {
    "subjectId": "6733ace331469552e145c6d0",
    "templateId": "5a56d31f5d17590170c1e28d",
    "startDate": "2025-07-21",
    "startTime": "9am"
  }'

Response (200)

{ 
   "message": "Review created"
}