API Reference
Assessments
Send personality, general, and developer assessments to candidates.
Assessment types
general— Big Five-derived traits and culture-fit signals.developer— Technical, behavioural, and architectural dimensions for engineering hires.personality— DISC-O profile with archetype labels and growth areas.
Lifecycle
pending— created, link sent, candidate has not started.in_progress— candidate has begun answering.completed— fully scored. Triggersassessment.completedwebhook.
REST endpoints
POST
/v1/assessmentsCreate an assessment for a candidate. Returns a tokenised invite URL.
assessments:writeGET
/v1/assessmentsList assessments, filterable by
assessments:readcandidate_id and type.GET
/v1/assessments/{id}Read assessment status, raw answers, and scored profile.
assessments:read