US English (US)
GB English (UK)
FR French
DE German
ES Spanish
IT Italian
NL Dutch
PL Polish
JP Japanese
BR Portuguese (Brazil)
RU Russian
SE Swedish
CN Chinese
IL Hebrew
N Traditional Chinese
FI Finnish
MS Malaysian
TR Turkish
KR Korean
AF Dari
SO Somali
ER Tigrinya
SA Arabic
CS Czech
LV Latvian
NO Norwegian
RO Romanian
MX Spanish (Mexico)
DA Danish
TH Thai
AU English (AUS)
BG Bulgarian
BE French (Belgium)
Mandarin
Thai (Thailand)
Belarusian
Mongolian
BS Bosnian
AR Spanish (Argentina)
PT Portuguese

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
English (US)
US English (US)
GB English (UK)
FR French
DE German
ES Spanish
IT Italian
NL Dutch
PL Polish
JP Japanese
BR Portuguese (Brazil)
RU Russian
SE Swedish
CN Chinese
IL Hebrew
N Traditional Chinese
FI Finnish
MS Malaysian
TR Turkish
KR Korean
AF Dari
SO Somali
ER Tigrinya
SA Arabic
CS Czech
LV Latvian
NO Norwegian
RO Romanian
MX Spanish (Mexico)
DA Danish
TH Thai
AU English (AUS)
BG Bulgarian
BE French (Belgium)
Mandarin
Thai (Thailand)
Belarusian
Mongolian
BS Bosnian
AR Spanish (Argentina)
PT Portuguese
  • Home
  • API V2 (OLD)

How To Retrieve Questions Through API

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.

  • Integrations
  • GDPR
  • Customization
    Customization Guides
  • API V3
  • API V2 (OLD)
  • Article Editor
  • Knowledge Base Settings
    Custom Domain Authentication Security Preferences
  • Getting Started
    New to Helpjuice? Start Here Users Accessibility Content Management Multiple Languages/Translations & Localization Multilingual Knowledge Bases Analytics
  • Swifty (In-App Widget)
  • Billing / Subscription
+ More

Note: You're located in section for advanced users. Please use this section only if you're familiar with API's.

Our public API provides access to any public knowledge base content, such as questions and categories.


Use the following URL to retrieve questions:

my_account.helpjuice.com/api/questions


You can further filter and order the questions returned via Query Parameters:

Parameter
Description
Type
Default
category_id
Returns only questions under this category.
Integer
null
limit
Limits the number of questions returned. The maximum limit is 1000. If you need all your records, you'll have to use this parameter combined with page.
Integer
250
page Useful to retrieve questions in chunks. Integer 1
order
Orders the questions returned. Allowed: "name" and "updated_at".
String
position
segments[key] Shows questions with the given segmentation fields. This option accepts multiple parameters with different keys, being able to specify multiple segmentation fields. Example: "/?segments[brand]=helpjuice&segments[name]=questions" String null
related_to Returns only questions related to the question parameterized.
Integer null


It's also possible to scope the questions within a specific language. To do so, just provide the desired language in the URL using the following syntax:

my_account.helpjuice.com/api/en_US/questions


Response:

[
  {
    "id":112828,
    "name":"Embedding Videos Into Your Knowledge Base",
    "views":394,
    "account_id":1885,
    "accessibility":1,
    "description":null,
    "email":"john.smith@example.com",
    "is_published":true,
    "is_juiced":false,
    "codename":"embedding-videos-into-knowledge-base",
    "language_id":1,
    "position":0,
    "created_at":"2014-11-24T20:15:53.865Z",
    "updated_at":"2016-01-23T17:00:51.389Z",
    "categories":[
      {
        "id":7732,
        "account_id":1885,
        "name":"Using Our Text Editor",
        "language_id":1,
        "accessibility":1,
        "created_at":"2014-11-19T16:30:44.994Z",
        "updated_at":"2016-03-10T14:58:21.011Z",
        "parent_id":7728,
        "lft":10312,
        "rgt":10313,
        "position":3,
        "codename":"using-our-text-editor",
        "index":0
      }]
  }
]

By default, questions will be showed in JSON format. However, it's possible to retrieve them in other 2 formats: XLS and CSV. To do so, you just need to specify the format in the URL, as follows:

my_account.helpjuice.com/api/questions.xls => to retrieve XLS spreadsheet
my_account.helpjuice.com/api/questions.csv => to retrieve a CSV file


Troubleshooting

  • Blank response: if you are not seeing any data, or you are receiving a corrupted file (in case of XLS), that's because your Knowledge Base is marked as internally only. Solution: if you are using a browser to access the data, just sign in before making the request. Otherwise, you'll need to use your Private Key (accessible under Settings > API Credentials) in a request parameter called api_key, like:
    • my_account.helpjuice.com/api/en_US/questions?api_key=MY_KEY
csv xls retrive json category api questions api retreving helpjuice api

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • How To Retrieve Searches Through API
  • Olark Integration
  • Overview: Customization
  • Popular Questions Standard Section

Copyright © 2021 - 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 success@helpjuice.com

Definition by Author

0
0
Expand