Note: You are in the advanced users section. Only use this section if you are familiar with APIs.
Use the following URL to get categories:
my_account.helpjuice.com/api/categories
You can further filter and organize the categories returned from Query Parameters:
| Parameter | Description | Type | Standard |
| parent ID |
Only returns questions under this category. | Round number | zero |
| to order | Orders the returned categories. Allowed: "name", "updated_at" and "created_at". | Wire | "position" |
| segments [key] |
Displays questions with the specified segmentation fields. This option accepts multiple parameters with different keys, allowing multiple segmentation fields to be specified. Example: "/? Segments [brand] = helpjuice & segments [name] = categories" |
Wire | zero |
It is also possible to arrange the categories within a specific language. To do this, simply specify the desired language in the URL using the following syntax:
my_account.helpjuice.com/api/en_US/categories
Response:
[
{
"id": 7730,
"name": "Design 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 are displayed in JSON format. However, it is possible to retrieve them in 2 other formats: XLS and CSV. To do this, you just need to specify the format in the URL, as follows:
my_account.helpjuice.com/api/categories.xls => to get XLS spreadsheet
my_account.helpjuice.com/api/categories.csv => to get a CSV file
Fix the problem
- Blank Answer : If you don't see any data, or if you receive a corrupted file (in the case of XLS), it's because your knowledge base is marked internal only . Solution: If you are using a browser to access the data, please log in before submitting the request. Otherwise, you need to use your private key (accessible from Settings> API credentials) in a request parameter called api_key , such as:
- my_account.helpjuice.com/api/en_US/questions?api_key= MY_KEY
