Skip to main content

API Routes

Base URL: https://www.jofiscore.com/api/v2

All routes below require an API key in the Authorization header unless noted otherwise. See API Keys.

Account, users, teams, and email templates​

GET /accounts
GET /users
GET /teams
GET /email-templates

Invitations​

POST /invitations
GET /invitations?team_id={teamId}
GET /invitations?custom_id={customId}
GET /invitations
GET /invitations/:invitationId
PUT /invitations/:invitationId

Test takers, scorecards, and job fit reports​

GET /test-takers?team_id={teamId}
GET /test-takers?custom_id={customId}
GET /test-takers
GET /test-takers/:testTakerId
GET /test-takers/:testTakerId/scorecard?sp={scoreProfileShortName}
GET /test-takers/:testTakerId/job-fit-report

Career navigation profiles​

GET /career-navigation-profiles
GET /career-navigation-profiles/:careerNavigationProfileId

Career Navigation data​

Additional read/update, favorite, scoring, and certificate routes are available under /career-navigation. See Career Navigation API for all 15 operations, account scoping, and revision handling.

Reference data​

GET /assessments
GET /score-profiles

Health check​

No API key required.

GET /healthcheck

Returns { "status": "ok", "timestamp": "...", "version": "v2" }. Use this to verify that the API is reachable.

Postman collection​

Download the Postman collection to try requests quickly.