List reviews

get

https://perform.trakstar.com/api/v1/reviews

List reviews for all active users in your organization. By default, returns archived (closed) reviews. Use the state parameter to include in-progress reviews. Using the include parameter functions similarly to how it works for searching for a singular review; the only difference, when using it, is that you will have multiple reviews in the data top-level member.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

include

string

value can be 'employee', 'manager', 'score_formatter', 'comments', 'threesixty_raters', 'shared_sections', 'single_use_sections', 'competencies', 'competency_scores', 'competency_comments', 'section_scores', 'goals', 'goal_scores', 'questions', 'goal_comments', or 'question_responses' or any combination of those values as a list of comma separated values.

filter[manager_score_numeric_min]

string

Manager score above this value

filter[manager_score_numeric_max]

string

Manager score below this value

filter[employee_score_numeric_min]

string

Employee score above this value

filter[employee_score_numeric_max]

string

Employee score below this value

filter[average_360_rater_score_numeric_min]

string

Average 360-Rater score above this value

filter[average_360_rater_score_numeric_max]

string

Average 360-Rater score below this value

filter[completed_on_min]

string

Archive date after this value

filter[completed_on_max]

string

Archive date before this value

filter[manager_id]

string

Manager ID matching this value

filter[employee_id]

string

Employee ID matching this value

page[number]

integer

Defaults to 1

page[size]

integer

Defaults to 100

Must be less than or equal to 100

sort

string

      Sorts the returned reviews. Reverse the order by prepending a hyphen to the parameter, e.g.
      sort=manager_score_numeric
      sort=-manager_score_numeric

      - manager_score_numeric - Numeric manager score
      - employee_score_numeric - Numeric employee score
      - average_360_rater_score_numeric - Numeric average 360-Rater score
      - manager_id - Manager ID
      - employee_id - Employee ID

state

string

Filter reviews by state. Accepts comma-separated values. Valid values are 'closed' and 'in_progress'. Defaults to 'closed' if not specified.

Headers

Content-Type

string

required

Defaults to application/vnd.api+json

string

enum

Defaults to application/vnd.api+json

Generated from available response content types

Allowed:

Responses

200Lists Reviews

400Bad Request

401Invalid token