BizKitHub
DocsAPI ReferenceProduct Parameter/bff/product-parameter/list
getProduct ParameterAdmin BFF

/bff/product-parameter/list

Returns all parameter definitions for the organisation. Each parameter includes its type, flags, associated group, and count of predefined values (for enum/color types). Optionally filtered by group code.

Product ParametergetBffProduct-parameterList

Parameters

1 query

Query parameters

· 1
groupCodestringOptional

Filter parameters by group code. If not provided, returns all parameters.

Exampletechnical-specs

Response schema

1 status code documented

200SuccessList of parameter definitions.
itemsobject[]Required

Parameters ordered by position then name.

Each array item:

Parameter definition item.

idnumberRequired

Internal parameter ID.

codestringRequired

Unique parameter code.

namestringRequired

Display name of the parameter.

groupobjectOptional

Group this parameter belongs to. Undefined if ungrouped.

codestringRequired

Group code.

namestringRequired

Group display name.

typestringRequired

Data type: string, number, boolean, enum, or color.

unitstringOptional

Unit label (e.g. "mm", "kg"). Only for number type.

filterablebooleanRequired

Whether this parameter should appear in frontend product filters.

comparablebooleanRequired

Whether this parameter should appear in the product comparison table.

variantFormingbooleanRequired

Whether this parameter forms product variants (e.g. "Size" creates variants, "Material" does not). Only enum/color.

multiValuebooleanRequired

Whether a product can have multiple values for this parameter (e.g. multiple colors). Only enum/color.

positionnumberRequired

Sort order position.

activebooleanRequired

Whether the parameter is active.

valueCountnumberRequired

Number of predefined values (relevant for enum/color types).

itemCountnumberRequired

Total number of parameters.

Response example

application/json
{
  "items": [
    {
      "id": 0,
      "code": "example_code",
      "name": "example_name",
      "group": {
        "code": "example_code",
        "name": "example_name"
      },
      "type": "example_type",
      "unit": "example_unit",
      "filterable": false,
      "comparable": false,
      "variantForming": false,
      "multiValue": false,
      "position": 0,
      "active": false,
      "valueCount": 0
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/product-parameter/list

get
curl -X GET "https://api.bizkithub.com/bff/product-parameter/list?groupCode=technical-specs" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key