Returns all currently active search fields. This is a filtered subset of the full field list, containing only fields with their active flag set to true.
Requires the searchfield:read or search.read permission.
Request
GET /field/active
Headers
| Header | Value |
|---|---|
Authorization | Bearer <token> |
Example Request
GET /field/active
Authorization: Bearer <token>Response
Returns a JSON array of active search field objects. The X-Total-Count response header contains the total number of active fields.
Response Body
| Field | Type | Description |
|---|---|---|
id | integer | Unique field ID. |
field | string | The index field name (e.g. "title", "manufacturer"). |
active | boolean | Always true for results from this endpoint. |
boostFactor | integer | Relevance boost factor applied during search. |
Example Response
[
{
"id": 1,
"field": "title",
"active": true,
"boostFactor": 10
},
{
"id": 2,
"field": "manufacturer",
"active": true,
"boostFactor": 5
}
]