Skip to content

Get Attributes List

GET/pimapi/v1/attributes

Retrieve a list of attributes matching specified query parameters and filtering criteria.


ParameterTypeRequiredDefaultDescription
changedOnstringNoDate range filter for modifications (e.g., gte:20200901223000). Supports absolute and relative offsets.
createdOnstringNoDate range filter for creation times.
languageIdstringNoLanguage tag to localize descriptions (e.g., en, de).
sortingstringNoField sorting instructions (e.g., +id, -changedOn). Prefix + for ASC and - for DESC.
pageintegerNo0Zero-indexed page number for pagination.
pageSizeintegerNo20Number of items per page.

Terminal window
curl -X GET "https://dev.pxm.eu.prodexa.com/pxm/pimapi/v1/attributes?page=0&pageSize=2" \
-H "X-API-KEY: your_hex_api_key" \
-H "Accept: application/json"

Returns a wrapper list containing metadata and matching attribute records.

{
"status": 200,
"meta": {
"languageId": "en",
"page": 0,
"pageSize": 2,
"totalElements": 15,
"totalPages": 8
},
"data": [
{
"attributeId": "COLOR",
"attribute.description": [
{
"languageId": "en",
"value": "Color"
}
]
},
{
"attributeId": "WEIGHT",
"attribute.description": [
{
"languageId": "en",
"value": "Weight"
}
]
}
]
}

Returned if no attributes match the criteria.

{
"status": 404,
"meta": {
"languageId": "en"
},
"error": "No Attributes found"
}