cURL
curl \
-X GET 'MEILISEARCH_URL/indexes/INDEX_UID/settings/facet-search' \
-H 'Authorization: Bearer API_KEY'client.index('INDEX_NAME').getFacetSearch();$client->index('INDEX_NAME')->getFacetSearch();client.index('books').get_facet_search_settings()client.index('INDEX_UID').facet_search_settingclient.Index("books").GetFacetSearch()await client.Index("books").GetFacetSearchAsync();let facet_search: bool = client
.index(INDEX_UID)
.get_facet_search()
.await
.unwrap();HttpResponse<String> response = Unirest.get("http://localhost:7700/indexes/{index_uid}/settings/facet-search")
.header("Authorization", "Bearer <token>")
.asString();true{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}{
"message": "Index `movies` not found.",
"code": "index_not_found",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#index_not_found"
}Facet search
Get facetSearch
Returns the current value of the facetSearch setting for the index.
GET
/
indexes
/
{index_uid}
/
settings
/
facet-search
cURL
curl \
-X GET 'MEILISEARCH_URL/indexes/INDEX_UID/settings/facet-search' \
-H 'Authorization: Bearer API_KEY'client.index('INDEX_NAME').getFacetSearch();$client->index('INDEX_NAME')->getFacetSearch();client.index('books').get_facet_search_settings()client.index('INDEX_UID').facet_search_settingclient.Index("books").GetFacetSearch()await client.Index("books").GetFacetSearchAsync();let facet_search: bool = client
.index(INDEX_UID)
.get_facet_search()
.await
.unwrap();HttpResponse<String> response = Unirest.get("http://localhost:7700/indexes/{index_uid}/settings/facet-search")
.header("Authorization", "Bearer <token>")
.asString();true{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}{
"message": "Index `movies` not found.",
"code": "index_not_found",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#index_not_found"
}Authorizations
An API key is a token that you provide when making API calls. Read more about how to secure your project.
Include the API key to the Authorization header, for instance:
-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'
If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:
const client = new MeiliSearch({
host: 'MEILISEARCH_URL',
apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'
});
Path Parameters
Unique identifier of the index.
Response
Returns the current value of the facetSearch setting.
The response is of type boolean.
Was this page helpful?