Access TalentScreen programmatically with REST API authentication
TalentScreen's REST API lets you build custom integrations, automate workflows, or sync data with your own systems. API keys provide secure, scoped access to your account data without exposing user credentials.
Keys can have read-only, write, or admin scope. Read-only keys fetch data but can't modify anything. Write keys create exams and candidates. Admin keys access billing and team settings. Always use the minimum scope needed.
Create Your API Key
Go to Settings > API > Generate Key. Name it descriptively (e.g., 'Production ATS Integration'). Select scope based on what your integration needs.
Copy and Store Securely
Your key appears once and can't be retrieved again. Save it in a password manager or secrets vault. Never commit keys to version control.
Make Your First Request
Use 'Authorization: Bearer YOUR_KEY' header. Test with GET /api/v1/me to verify authentication works. Check our API docs for full endpoint reference.
Handle Rate Limits
Free plans: 100 req/hour. Pro: 1000/hour. Enterprise: custom. Respect 'X-RateLimit-Remaining' headers. Implement exponential backoff for retries.
Monitor API Usage
View request logs, error rates, and quota usage in Settings > API > Analytics. Set up alerts when approaching rate limits.
Rotate API keys every 90 days or immediately if compromised. Treat keys like passwords. They grant full account access within their scope.
Sync candidates to your CRM, trigger exams when candidates apply via your careers page, fetch results for internal dashboards, or automate bulk operations like invitation scheduling. See our API cookbook for code examples.
Was this article helpful?