Categories
GEThttps://instancename.piminto.com/api/en-us/v/ct
- Requires Data Viewer ApiKey permissions.
- Example URI: https://instancename.piminto.com/api/en-us/v/ct
Provides the ability to retrieve the entire structure and hierarchy of categories in your Product Information Management System (PIMS).
Returns
The endpoints returns detailed information about a category, including any subcategories that belong to or have been assigned to it. The information returned includes all the data necessary to understand the category hierarchy in the PIMS.
In this endpoint, the cat_data metadata field includes only the cat_image attribute, the path to the category image.
This API call provides a comprehensive and flexible way to retrieve information about categories in your PIMS and can be useful for applications that need to display navigation menus or category hierarchies for user viewing.
Request
Responses
- 200
success
- application/json
- Schema
- Example (from schema)
Schema
The status of the API request. A value of "OK" indicates that the request was successfully sent and processed.
categoriesTree object[]required
{
"status": "OK",
"categoriesTree": [
{
"id": 6,
"cat_name": "Category-1 Name",
"cat_parent_id": 2,
"cat_path_id": "2 > 6",
"cat_path": "Category Name > Category-1 Name",
"cat_order": 1,
"cat_rank": 10,
"cat_data": {
"cat_image": "https://instancename.com/data/category.jpg"
}
}
]
}
Authorization: ApiKey
name: ApiKeytype: apiKeyin: header
- curl
- python
- nodejs
- php
- java
- CURL
curl -L -X GET 'https://instancename.piminto.com/api/en-us/v/ct' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>'