This article shows how to get a list of questions using the API, as well as how to retrieve the details of a single question by its ID. Use these endpoints to programmatically access your knowledge base content.

In this article, you’ll learn:

• How to retrieve multiple questions with filters
• How to fetch an individual question by its ID
• How to interpret question data returned by the API
• Best practices when using these endpoints

What Are Questions?

“Questions” is related to the Article Title. This means you'll retrieve a list of article titles when you use the API calls listed in this article.

Retrieving Multiple Questions:

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:

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:

your_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:

your_account.helpjuice.com/api/questions.xls => to retrieve XLS spreadsheet

your_account.helpjuice.com/api/questions.csv => to retrieve a CSV file

Retrieving an Individual Question

To retrieve a specific Question, use the following URL:

your_account.helpjuice.com/api/questions/[QUESTION_ID]

If the ID you provided exists, you'll get a 200 Response with a response of the template as such:

{
  "id":112828,
  "name":"Embedding Videos Into Your Knowledge Base",
  "views":394,
  "account_id":1885,
  "accessibility":1,
  "slug":null,
  "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",
  "answer":"\u003cp\u003eWhile writing articles, ..."
}

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 Internal.
  •  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 in a request parameter called api_key. See How to Get Your API Key.
    • Example: your_account.helpjuice.com/api/en_US/questions?api_key=MY_KEY

Best Practices

• Use pagination (page + limit) to avoid performance issues when retrieving many questions.
• Filter by category_id to get focused subsets of your content.
• If your KB is internal-only, always include the api_key for authenticated access.
• Consistently use language-scoped endpoints when your KB supports multiple languages.