How To Retrieve Categories Through API

Written By Diego Selzein (Administrator)

Updated at May 20th, 2020

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:

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

Parameter Description Type Default
Returns only questions under this category. Integer null
order Orders the categories returned. Allowed: "name", "updated_at" and "created_at". String "position"
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"
String null

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:


    "name":"Designing Your Knowledge Base",
    "name":"General Questions",

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: => to retrieve XLS spreadsheet => to retrieve a CSV file


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

Was this article helpful?