Returns a paginated list of recommendation configurations for the current instance.
Request
GET /reco
Headers
| Header | Value |
|---|---|
Authorization | Bearer <token> |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
_sort | string | No | Field to sort by. Defaults to name. |
_order | string | No | Sort direction: ASC or DESC. Defaults to ASC. |
_start | integer | No | Offset for pagination. Defaults to 0. |
_end | integer | No | Number of results to return. Defaults to 10. |
q | string | No | Filter by name (case-insensitive substring match). |
active | string | No | Filter 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
| Field | Type | Description |
|---|---|---|
id | integer | Unique recommendation configuration ID. |
name | string | Display name of the recommendation. |
active | boolean | Whether the recommendation is active. |
recommendationType | string | Algorithm type (e.g. textSimilarity, boughtTogether, cartBased, userBased, pictureSimilarity, none). |
user | string | Email of the user who last modified the configuration. |
Example Response
[
{
"id": 1,
"name": "Similar Products",
"active": true,
"recommendationType": "textSimilarity",
"user": "[email protected]"
}
]
