Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Scorecard Questions

List scorecard questions

Scorecard questions are the prompts configured on an interview_kit that interviewers answer when submitting a scorecard. Each question has a question body and an answer_type (text, yes_no, single_select, multi_select, or instruction); single_select and multi_select questions reference their choices through /v3/scorecard_question_options. Interviewer responses are returned separately as scorecard_question_answers on a candidate's scorecards. Filter to a single kit with interview_kit_id and to live questions with active=true.

get/v3/scorecard_questions

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
interview_kit_idsinteger[]

Return only scorecard questions attached to these interview kit ids. An interview kit is a stage's interview definition on a job, and its scorecard questions make up the rubric interviewers score against; look up kits for a job via GET /v3/interview_kits?job_ids=....

fieldsstring[]

Comma separated list of fields to return

activeboolean

Filter by whether the question is still in use on its interview kit. Defaults to returning both active and removed questions; set true for live questions only, false for removed only.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
interview_kit_idinteger

Id of the interview kit this question belongs to. Each interview_kit carries its own ordered set of scorecard questions, so the same prompt configured on two kits has two distinct scorecard_question rows.

questionstring

Text of the scorecard question — or, when answer_type is instruction, the body of the display-only instruction shown to interviewers. Supports basic HTML formatting (<p>, <ul>, <li>, <b>, <i>, <a>). Render or sanitize as needed.

sort_orderinteger

Position of this question within its interview kit, ascending. Lower values render first; aliased from the underlying priority column. Questions and instruction rows share a single ordering.

activeboolean

true when the question is in use; false after it has been removed from the kit. Inactive questions are returned by default — pass active=true to filter to live questions only. Past scorecard_question_answers still reference inactive rows so historical scorecards stay readable.

answer_type'text' | 'yes_no' | 'single_select' | 'multi_select' | 'instruction'

Shape of the answer the interviewer fills in. text is free-form rich text; yes_no is a binary choice; single_select and multi_select pick from the question's scorecard_question_options; instruction is a display-only guidance row with no answer field and no required semantics — instructions exist to script interviewers and do not produce a scorecard_question_answer. Immutable after the question is created.

requiredboolean

If true, an interviewer must answer this question before submitting the scorecard. Ignored when answer_type is instruction.