Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Book a Demo
  • Product Updates
  • Contact Us
  • Home
  • API & Webhooks
  • API V2

How To Authenticate API Requests

Securely access your Helpjuice knowledge base via API

Written by Emil Hajric

Updated at September 29th, 2025, by Amanda Helpjuice

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Getting Started
    Managing Users Permissions & Accessibility Content Management Analytics Video Tutorials
  • Article Editor
  • Swifty AI
  • Languages & Translations
  • Settings
    User Settings User Behavior Knowledge Base Settings Custom Domain
  • Authentication
  • Customization
    Customization Guides
  • API & Webhooks
    API V3 API V2
  • Billing / Subscription
+ More

Table of Contents

When an API Token is Required When an API Token Is Not Required How to Authorize Guests via API Troubleshooting Best Practices

Authentication ensures only authorized users can access your knowledge base content through the API. Helpjuice provides API Tokens to manage access for both external and internal content.

In this article, you’ll learn:

  • When an API Token is required
  • How to authorize guests via API
  • How to include the API key in requests
  • Troubleshooting access issues

When an API Token is Required

  • Guests with a valid API Token: Can access both internal and external questions.
  • Guests with an invalid API Token: Cannot access the knowledge base at all.

When an API Token Is Not Required

Guests can access external questions only, provided the internal_kb option is not checked.

How to Authorize Guests via API

To allow guests to access internal questions:

  1. Enable the Require API Token setting at your_account.helpjuice.com/admin/en_US/settings/api_credentials
  1. Include your API Key in the request:
  • Query Parameter: ?api_key=YOUR_API_KEY

Only Super Administrators have access to the API section.

 

Troubleshooting

  • Ensure the correct API key is included in the request header or query parameter.
  • Verify that the Require API Token setting matches your intended access rules.
  • Guests cannot access internal questions without a valid API Token.

Best Practices

  • Keep your API keys secure; do not share them publicly.
  • Regularly rotate API keys to maintain security.
  • Test access after changing token settings to confirm proper permissions.
verify request api auth

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • How To Retrieve Categories Through API

Copyright © 2025 - Helpjuice

Helpjuice, Inc. is a registered US Corporation, EIN # 45-2275731

Download W9
  • Help
  • Features
  • Pricing
  • About
  • Careers
  • Customers
  • Blog
  • Case Studies
  • Resources
  • Knowledge Base Examples
  • Privacy Policy
  • Terms of Service

Why is the knowledge base important?

With a knowledge base, you can allow your customers to self-help themselves, thus reducing your customer support by up to 60%. Furthermore, you can also have your team get instant answers to the questions they need without having to email themselves all using knowledge base software.

What is the purpose of a knowledge base?

The purpose of knowledge base software is to allow you to host your knowledge base/corporate wiki in one centralized 'hub'. Both your customers, and employees can now access information within seconds!

Made with from Miami, Bosnia, Morocco & Brasil

+1 (833) 387 3877 support@helpjuice.com
Expand