v1
latestSwagger 2.02026-07-13137761.0 MBFamily
Get list of families
This endpoint allows you to get a list of families. Families are paginated and sorted by code.
get/api/rest/v1/families
Query parameters
searchstring
Filter families, for more details see the <a href="/documentation/filter.html#filter-families">Filters</a> section.
pageinteger
Number of the page to retrieve when using the page pagination method type. <strong>Should never be set manually</strong>, see <a href="/documentation/pagination.html#pagination">Pagination</a> section
limitinteger
Number of results by page, see <a href="/documentation/pagination.html">Pagination</a> section
with_countboolean
Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
Response
Return families paginated
Example response
{
"_embedded": {
"items": [
{
"code": "caps",
"attributes": [
"sku",
"name",
"description",
"price",
"color",
"picture"
],
"attribute_as_label": "name",
"attribute_as_image": "picture",
"attribute_requirements": {
"ecommerce": [
"sku",
"name",
"description",
"price",
"color"
],
"tablet": [
"sku",
"name",
"description",
"price"
]
},
"labels": {
"en_US": "Caps",
"fr_FR": "Casquettes"
}
}
]
}
}