Ready to supercharge your hiring workflow? Truffle's API lets you connect your favorite tools and automate your recruiting process like never before. Whether you're syncing candidates with your CRM or building custom integrations, we've got you covered.
Who Can Use the API?
Our API is available exclusively for paid Truffle accounts. To get started, you'll need to:
Have an active paid subscription - The API is a premium feature for our paying customers
Request API access - We review each request to ensure you have everything you need for success. You can do this directly from your Company Settings - Integrations page in the Truffle app
Get approved - Once approved, you'll be able to create and manage your API keys
Don't have a paid account yet? Upgrade your plan to unlock API access and other advanced features.
Creating Your First API Key
Once you have API access enabled, creating your API key is straightforward:
Navigate to Settings - Click on your profile menu and select "Company Settings"
Find API & Integrations - Look for "API & Integrations" in your settings sidebar
Click "Create API Key" - Hit the blue "Create API Key" button to get started
Name your key - Give it a descriptive name like "Zapier Integration" or "CRM Sync"
Add a description (optional) - Help your team understand what this key is for
Set permissions - Choose the right level of access for your integration:
Read Access: View candidates, jobs, and screening results
Write Access: Create candidates, send invites, and update records
Admin Access: Full access including webhooks and settings
Understanding API Key Permissions
Read Access is perfect for:
Pulling candidate data into your CRM
Creating custom reports and dashboards
Syncing hiring data with other tools
Write Access lets you:
Add new candidates directly to Truffle
Update candidate information
Send interview invitations
Create new job postings
Admin Access gives you:
Everything in Read and Write access
Webhook management
Account settings access
Full integration capabilities
Pro tip: Always use the minimum permissions needed for your specific use case. It's better for security and easier to manage.
Keeping Your API Keys Safe
Your API keys are like the front door key to your hiring data - keep them secure!
✅ Do:
Store API keys in secure environment variables
Use different keys for different integrations
Regenerate keys if you suspect they've been compromised
Keep keys out of public repositories and client-side code
❌ Don't:
Share API keys in public spaces (GitHub, forums, etc.)
Include keys in screenshots or documentation
Use the same key for multiple integrations
Store keys in plain text files
Getting Help
We're here to help you succeed with your API integration:
Documentation: Check out our developer documentation for detailed endpoint information
Support: Have questions? Chat with us in-app or email [email protected]
Feature requests: Don't see an endpoint you need? Let us know! We regularly add new capabilities based on customer feedback