Skip to content

Get Group and Subgroups

GET/pimapi/v1/classifications/{classificationId}/groups/{classificationGroupId}

Retrieve properties of a specific classification group, with optional recursive loading of its child subgroups up to a specified depth.


ParameterTypeRequiredDescription
classificationIdstringYesUnique ID of the classification system (e.g., ECLASS_10).
classificationGroupIdstringYesID of the classification group (e.g., FASTENERS).
ParameterTypeRequiredDefaultDescription
levelsintegerNoDetermines the depth of subgroups to load:
Null (omitted): specified group details only.
0: Load all levels of nested child subgroups.
1 or higher: Load child subgroups up to the specified nesting depth.
languageIdstringNoLanguage tag to localize descriptions (e.g., en, de).

Terminal window
curl -X GET "https://dev.pxm.eu.prodexa.com/pxm/pimapi/v1/classifications/ECLASS_10/groups/FASTENERS?levels=0&languageId=en" \
-H "X-API-KEY: your_hex_api_key" \
-H "Accept: application/json"

Returns a wrapper object where data contains the requested group and its subgroups (nested recursively).

{
"status": 200,
"meta": {
"languageId": "en"
},
"data": [
{
"classificationGroupId": "FASTENERS",
"shortDescription": [
{
"languageId": "en",
"value": "Fasteners"
}
],
"fallbackDescShort": [
{
"languageId": "en",
"value": "Fasteners"
}
],
"longDescriptions": [
{
"languageId": "en",
"value": "All varieties of industrial fasteners"
}
],
"documentUrl1": null,
"documentUrl2": null,
"documentUrl3": null,
"orderNo": 1,
"statusID": "ACTIVE",
"attributes": [],
"createdOn": "2026-06-15T09:00:00Z",
"createdBy": "admin",
"changedOn": "2026-06-15T09:00:00Z",
"changedBy": "admin"
},
{
"classificationGroupId": "SCREWS",
"parentClassificationGroupId": "FASTENERS",
"shortDescription": [
{
"languageId": "en",
"value": "Screws"
}
],
"fallbackDescShort": [
{
"languageId": "en",
"value": "Screws"
}
],
"longDescriptions": [
{
"languageId": "en",
"value": "Threaded metal screws and fasteners"
}
],
"documentUrl1": null,
"documentUrl2": null,
"documentUrl3": null,
"orderNo": 10,
"statusID": "ACTIVE",
"attributes": [
{
"attributeId": "THREAD_SIZE",
"attribute.description": [
{
"languageId": "en",
"value": "Thread Size"
}
]
}
],
"createdOn": "2026-06-15T09:00:00Z",
"createdBy": "admin",
"changedOn": "2026-06-17T11:00:00Z",
"changedBy": "admin"
}
]
}

Returned if the group doesn’t exist within the specified classification system.

{
"status": 404,
"meta": {
"languageId": "en"
},
"error": "No Classification group [FASTENERS] found within classification [ECLASS_10]"
}