Skip to main content
POST
Create scorecard

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Body

application/json
person_id
string<uuid>
required

Person UUID being evaluated (required).

assessment_template_id
string<uuid>
required

Scorecard template UUID used to score the person (required).

job_id
string<uuid>

Job UUID to scope this scorecard to. When set, the candidate_id is auto-resolved from the (person_id, job_id) candidate record.

overall_rating
number | null

Overall score (0 to template rating_scale). Optional — leave null to score only at the criterion level.

Required range: 0 <= x <= 10
overall_comment
string

Plain-text overall summary note.

is_starred
boolean
default:false

Whether to mark this scorecard as starred. Defaults to false.

Whether to expose this scorecard on the client share link for the linked job. Only respected when job_id is set. Defaults to false.

team_member_id
string<uuid>

Team member UUID to record as the scorecard creator. Defaults to the caller. Required when the caller is authenticated with an API key (no team member context).

criterion_ratings
object[]

Per-criterion ratings and comments. Each entry must reference a criterion_id belonging to the assessment_template_id and must include a rating, a comment, or both.

Response

Scorecard created

success
enum<boolean>
required
Available options:
true
data
object
required