How to Get Your API Key
Obtain your Helpjuice API key to integrate and authenticate API requests
Written by Emil Hajric
Updated at September 24th, 2025, by Amanda Helpjuice
To interact with Helpjuice's API v3, you'll need a unique API key. This key authenticates your requests and grants access to your account's data. Follow the steps below to retrieve your API key.
In this article, you’ll learn:
- How to access your API credentials page
- Steps to generate and copy your API key
- Important considerations for API key security
- Best practices for managing your API key
Accessing Your API Credentials
- Navigate to your Helpjuice account and log in with your credentials.
- Click on your profile icon in the bottom-left corner and select Settings.
- In the settings menu, click on API Credentials
- Check the box labeled Require token for API?.
- Your Private Key will be displayed. Click Copy to save it to your clipboard.
- Save Changes
Only Super Administrators and Account Owners have access to the API Credentials settings page.
Important Considerations
- Security: Keep your API key confidential. Do not share it or expose it in client-side code.
- Permissions: The API key grants Super Administrator privileges to anyone with access to it.
- Access: Each account has its own unique API key.
Best Practices
- Environment Variables: Store your API key in environment variables to keep it secure.
- Access Control: Limit access to your API key to trusted individuals and systems.
- Regular Audits: Periodically review and regenerate your API keys to enhance security.