Path A: Dashboard (recruiting / ops)
No API key. No terminal.Option 1: Jobs first (recommended)
1
Sign in to Assess
Open the Assess dashboard.
2
Create a job
Go to Jobs → New job. Pick a hiring squad, write the description, and optionally link an assessment or pipeline.
3
Publish and review applicants
Publish the job. Candidates apply from your careers URL. On the job’s Candidates tab, screen, advance, or reject. Advance sends them toward assessment when configured.
Option 2: Assessment-only invite
1
Create or open an assessment
Add tasks, set time limit and passing score, then set status to Active. Invites fail if the assessment is still a draft.
2
Invite a candidate
Use Invite on that assessment. Enter email and name. Assess can send the email for you.
3
Watch for completion
When they finish, open Results on the assessment.
Path B: Public API (engineers)
Hire in the same order as the product: jobs → applications, or skip to assessments if you already source elsewhere. OpenAPI / ReDoc list Jobs first: API Reference · live ReDoc.Prerequisites
- Organisation on Starter or above (Free cannot create API keys)
- An owner, admin, or developer role (recruiters cannot mint keys)
- For jobs: a hiring squad UUID (
team_id) - For invites: an active assessment
1
Create an API key
Open Assess → Developer → API Keys, create a key, and copy it (shown once). Live keys start with
ct_live_; switch the dashboard to Test to mint ct_test_….Prefer least-privilege scopes. Empty scopes grant full access (legacy). For jobs automation use jobs:read, jobs:write, applications:read, applications:write.2
Set your environment
3
List jobs (or create one)
team_id / squad_id, then POST /jobs/{key}/publish/. Full table: Jobs.4
List or create applications
POST /applications/{id}/advance/ (does not auto-invite everyone who applies).5
Optional: invite to an assessment
Safe to retry: same email on the same assessment returns the existing invite. Default Save
send_email is false. Set true to have Assess email them.invite_token from the response.6
Fetch the result
assessment.completed, application.advanced, …) instead of polling.Install an SDK (optional)
Next
Jobs & applications
Openings, apply, advance, reject.
Authentication
Keys, scopes, and safe rotation.
API Reference
Jobs-first OpenAPI and ReDoc.
Webhooks
Get notified when candidates finish.