v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Scorecard Question Options

List scorecard question options

Scorecard question options are the multiple-choice values shown to interviewers for single_select and multi_select scorecard_questions. Each option belongs to a single parent question; the interviewer's selection is recorded on a scorecard_question_answer through the scorecard_question_answer_options join. Filter to a single question with scorecard_question_id and to live options with active=true.

get/v3/scorecard_question_options

Query parameters

cursorstring

Cursor link for pagination from previous page response header. Do not use any other parameters when using this.

per_pageinteger

Number of results per page

idsinteger[]

Comma separated list

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
scorecard_question_idsinteger[]

Comma separated list

fieldsstring[]

Comma separated list of fields to return

activeboolean

Filter by whether the option is still selectable on its parent question. Defaults to returning both active and removed options; set true for live options only, false for removed only.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
scorecard_question_idinteger

Id of the parent scorecard_question this option belongs to. Only questions with answer_type of single_select or multi_select carry options.

namestring

Display label shown to interviewers in the scorecard dropdown (e.g. Strong Hire, No Hire). Persisted verbatim as the choice text on scorecard_question_answers that select this option via the scorecard_question_answer_options join.

sort_orderinteger

Display position within the parent question's choice list. Lower values render first; ties fall back to insertion order. Alias of the underlying priority column.

activeboolean

true while the option is selectable on new scorecards. Set to false after removal — historical scorecard_question_answers that already selected the option are preserved, so past scorecards still resolve to the original label.