List recommendation configurations

Returns a paginated list of recommendation configurations for the current instance.

Request

GET /reco

Headers

HeaderValue
AuthorizationBearer <token>

Query Parameters

ParameterTypeRequiredDescription
_sortstringNoField to sort by. Defaults to name.
_orderstringNoSort direction: ASC or DESC. Defaults to ASC.
_startintegerNoOffset for pagination. Defaults to 0.
_endintegerNoNumber of results to return. Defaults to 10.
qstringNoFilter by name (case-insensitive substring match).
activestringNoFilter by active status. Pass true or false.

Example Request

GET /reco?_sort=name&_order=ASC&_start=0&_end=10

Response

Returns a JSON array of recommendation configuration objects. The X-Total-Count response header contains the total number of matching configurations.

Response Fields

FieldTypeDescription
idintegerUnique recommendation configuration ID.
namestringDisplay name of the recommendation.
activebooleanWhether the recommendation is active.
recommendationTypestringAlgorithm type (e.g. textSimilarity, boughtTogether, cartBased, userBased, pictureSimilarity, none).
userstringEmail of the user who last modified the configuration.

Example Response

[
  {
    "id": 1,
    "name": "Similar Products",
    "active": true,
    "recommendationType": "textSimilarity",
    "user": "[email protected]"
  }
]