Appearance

List Scorecards ​

Endpoint ​

http
GET /unified/ats/scorecards
Integrations supported
  • Ashby
  • Breezy
  • Greenhouse

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
organization_id
string

The ID of the organization to filter the scorecards by.

Supported in
  • Breezy
job_id
string

The ID of the job to filter the scorecards by.

Required in
  • Breezy
candidate_id
string

The ID of the candidate to filter the scorecards by.

Required in
  • Breezy
application_id
string
Integration specific notes
  • GreenhouseThe application's unique identifier. If specified, no other query parameters can be used.
  • AshbyThe application's unique identifier.
Supported in
  • Ashby
  • Greenhouse
created_at
string · date-time

The date and time of the scorecard's creation

Supported in
  • Greenhouse
updated_at
string · date-time

The date and time of the scorecard's last update

Supported in
  • Greenhouse

Response Body ​

result
object[]

List of Scorecards

id
string
REQUIRED · 

The scorecard's unique identifier

Supported in
  • Ashby
  • Breezy
  • Greenhouse
application
object

The scorecard's application

Supported in
  • Ashby
  • Greenhouse
id
string

Unique identifier of the application

candidate
object

The scorecard's candidate

Supported in
  • Greenhouse
id
string

Unique identifier of the candidate

interview
object

The scorecard's interview

Supported in
  • Greenhouse
id
string

Unique identifier of the interview

interviewer
object

The scorecard's interviewer

Supported in
  • Ashby
  • Breezy
  • Greenhouse
id
string

Unique identifier of the user

submitted_at
string · date-time

The scorecard's submitted date

Supported in
  • Ashby
  • Greenhouse
overall_recommendation
string

The scorecard's overall recommendation

Supported in
  • Breezy
  • Greenhouse
form_values
object[]

The scorecard's form values

Supported in
  • Ashby
name
string

The form field's name

label
string

The form field's label

description
string

The form field's description

value
string

The form field's value

created_at
string · date-time

The date and time of the scorecard's creation

Supported in
  • Ashby
  • Greenhouse
updated_at
string · date-time

The date and time of the scorecard's last update

Supported in
  • Greenhouse
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.