Skip to main content

Getting Started

Welcome to the JOFI API v2 documentation. See the changelog for recent updates.

Base URL​

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

Authentication​

Include your API key as a Bearer token on every request:

Authorization: Bearer sk_live_ELABcdEFghIJkl

Your API key is linked to one JOFI account. All requests read and write data for that account only. You will receive two keys: sk_live_... for production and sk_test_... for development. Contact your JOFI representative to obtain keys. See API Keys for test-mode behavior.

Before you integrate​

Work with your JOFI representative to complete the setup checklist: API keys, teams, users, inviter defaults, and optionally webhooks.

How it works​

Your system sends invitations via the API. Participants take assessments on JOFIscore.com. Your team reviews scores and reports, then proceeds based on your use case: hiring, career coaching, or team building. See Integration flow for the step-by-step walkthrough.

Next steps​

tip

Looking for the v1 documentation? You can still find it here, but we recommend moving to the v2 API as soon as you can.