List fields that will be used for search

List all fields that will be used for searches.

For every field that is listed here and active, the final search result will be determined by looking for the search term in that field.

Returns a list of all document fields configured for search. These fields determine which product data is indexed and searchable.

Requires authentication.

Request

GET /field

Headers

HeaderValue
AuthorizationBearer <token>

Response

Returns a JSON array of field objects.

Response Body

FieldTypeDescription
idintegerUnique field ID.
fieldstringDocument field identifier.
activebooleanWhen false, this field is excluded from search.
boostFactornumberSearch relevance boost (1–10). Higher values increase the importance of matches in this field. 1 means no boost.
Headers
string
required

Makaira Instance ID

Response
200

OK

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!