Retrieving Categories through API

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


Use the following URL to retrieve categories:

my_account.helpjuice.com/api/categories


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

ParameterDescriptionTypeDefault
parent_id
Returns only questions under this category.Integernull
orderOrders the categories returned. Allowed: "name", "updated_at" and "created_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]=categories"
Stringnull


It's also possible to scope the categories 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/categories


Response:

[
  {
    "id":7730,
    "name":"Designing Your Knowledge Base",
    "codename":"designing-your-knowledge-base",
    "parent_id":null,
    "created_at":"2014-11-19T16:30:03.676Z",
    "updated_at":"2016-02-11T20:15:42.718Z"
  },{
    "id":7729,
    "name":"General Questions",
    "codename":"general-questions",
    "parent_id":null,
    "created_at":"2014-11-19T16:29:56.223Z",
    "updated_at":"2016-02-11T20:15:42.718Z"
  }
]

By default, categories 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/categories.xls => to retrieve XLS spreadsheet
my_account.helpjuice.com/api/categories.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
Was this article helpful?

Can't find what you're looking for?

Contact Support