- What is TestInvite?
- Build Your First Test
- Run Your First Assessment
- Taking the Assessment
- Viewing the Results
- Question Bank Overview
- Common Question Features
- Scoring
- Question Types
- Question Authoring
- Browsing Questions
- Content Blocks
- Media Library
- Metadata Rules & Schema
- Roles & Access
- Tests Overview
- My Tests
- Creating a Test
- The Test Editor
- Test Settings
- Sections & Pages
- Adding Questions
- Page Builders
- Test Profile
- Reporting
- Test Papers
- Analytics
- Publishing a Test
- Test Library
- Marketplace
- Tasks Overview
- Creating a Task
- Task Dashboard
- Steps
- Task Settings
- Candidates
- Test Sessions
- Sent Mails
- Proctoring
- Analytics
- Analytics Overview
- Test Analytics
- Question Analytics
- Per-Question Analytics
- Results Explorer
- Segment Analysis
Enabling the API
Turn on the API, create an access key with only the permissions it needs, and get the authorization token every request will use — all from Organization → Integration/API.
Activating the API
Go to Organization → Integration/API and turn on the Active switch. This may require a plan upgrade or add-on depending on your subscription — check Billing if the switch is unavailable.
Creating an Access Key
Once active, click Create to generate an access key. Give it a title and choose which permissions it grants — see Access Roles below for the full list. Create separate keys for separate integrations (your careers site, your LMS, a Zapier connection) so you can revoke or scope each one independently instead of sharing a single all-access key everywhere.
Finding Your Private Key and Authorization Token
Open the key icon on any access key's row to reveal both values, each with a copy button:
- Private Key — the raw secret for this access key.
- Authorization Token — the value you actually put in every request's
Authorizationheader. It's your organization ID and private key combined and encoded together, generated for you so you never have to build it by hand.
Each access key is granted one or more of nine permissions — grant only what an integration actually needs, since every key can be scoped independently.