GRgreenhouse
Scorecards

Update scorecard

Patch an existing scorecard. The body replaces values wholesale on the fields it includes — sending a new notes value overwrites the previous one rather than appending. Set status to complete to submit a draft scorecard (this stamps submitted_at and ends the edit window for non-admin users). Editing submitted scorecards is governed by the organization's scorecard-edit permissions: Site Admins can edit any time, while Job Admins are bound by the 30-day edit window.

patch/v3/scorecards/{id}

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/scorecards/{id}
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:scorecards:update
    • or HTTP bearer

Path parameters

idinteger required

Request body

interviewer_idinteger required

Id of the Greenhouse user this scorecard is assigned to (the interviewer being scored against).

interviewed_atstring date-time required

Timestamp the interview took place, in ISO 8601.

notesstring

Free-text "key takeaways" (pros, cons, follow-ups). Replaces the existing value wholesale.

candidate_rating'strong_no' | 'no' | 'yes' | 'strong_yes' | 'no_decision'

Overall recommendation. One of strong_no ("Definitely Not"), no, yes, strong_yes, or no_decision.

private_notesstring

Free-text private notes; only readers with the "see private notes" permission see these. Replaces the existing value wholesale.

status'draft' | 'complete'

Lifecycle status. Move a draft to complete to submit (Greenhouse stamps submitted_at on transition). Site Admins can edit submitted scorecards at any time; Job Admins are bound by the organization's scorecard-edit window.

public_notesstring

Free-text "note to other interviewers". Replaces the existing value wholesale.

submitter_idinteger required

Id of the user submitting (or last editing) the scorecard. Usually matches interviewer_id.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
interview_kit_idinteger

Id of the interview kit this scorecard was filled out against. The kit determines the questions, focus attributes, and rating scale on the scorecard. The kit also identifies which interview slot on the job's interview plan produced this scorecard.

interviewer_idinteger

Id of the Greenhouse user who participated in the interview and to whom this scorecard is assigned. Each interviewer on a multi-interviewer interview gets their own scorecard.

interviewed_atstring date-time nullable

Timestamp the interview took place, in ISO 8601. Mirrors the underlying interview's scheduled time and is set when the scorecard is created (manual scorecards may set this independently).

notesstring nullable

Free-text "key takeaways" the interviewer recorded on the scorecard (pros, cons, follow-ups). Plain text with @-mentions rendered as user names; use notes_with_tags for the version where mentions are tagged for downstream parsing.

notes_with_tagsstring nullable

notes with @-mentions rendered as embedded user tags (e.g. @[User Name](user:123)) instead of plain user names, for partners that need to resolve mentioned users.

submitter_idinteger

Id of the Greenhouse user who actually submitted the scorecard. Usually the same as interviewer_id, but differs when an admin submits a scorecard on another interviewer's behalf.

candidate_ratingstring

Interviewer's overall recommendation on whether the candidate passed the interview. One of strong_no ("Definitely Not" in the UI), no, yes, strong_yes, or no_decision. no_decision is recorded when the interviewer submitted the scorecard without choosing a recommendation.

private_notesstring nullable

Free-text private notes visible only to users with the "see private notes" permission. Plain text with @-mentions rendered as user names; use private_notes_with_tags for the tagged version.

private_notes_with_tagsstring nullable

private_notes with @-mentions rendered as embedded user tags instead of plain user names.

status'draft' | 'complete'

Lifecycle status of the scorecard. complete is submitted feedback (and submitted_at is set). draft is an autosaved working copy owned by the user who opened the form; it is not shown as feedback and does not mean feedback is owed. Only complete scorecards count toward interview completion and downstream analysis.

public_notesstring nullable

Free-text "note to other interviewers" the interviewer leaves for the rest of the hiring team. Plain text with @-mentions rendered as user names; use public_notes_with_tags for the tagged version.

public_notes_with_tagsstring nullable

public_notes with @-mentions rendered as embedded user tags instead of plain user names.

application_idinteger

Id of the application this scorecard belongs to. Use it to look up the candidate via the applications endpoint.

submitted_atstring date-time nullable

Timestamp the scorecard was submitted (moved from draft to complete), in ISO 8601. null while status is draft. The delta between interviewed_at and submitted_at is a common "time to submit scorecard" measure.

Changes

No recorded changes to this operation across all 1 revision of this API.