API Reference / API Parameters / unretrievableAttributes
Type: list of strings
Engine default: [] (no attribute is unretrievable)
Parameter syntax
'unretrievableAttributes' => [

Can be used in these methods:

About this parameter

List of attributes you don’t want the engine to retrieve at query time.

Preventing particular attributes from being retrieved may be particularly important for security or business reasons. Some attributes may be helpful for ranking or other technical purposes but should never be seen by your users, for example, total sales, permissions, and other private information. This setting guarantees this. Attribute names are case-sensitive.

There’s no limit to the number of attributes in the list, but having many attributes slows down calls to getSettings. This can make the Algolia dashboard slower and less responsive.

Usage notes

This setting is ignored if the query is authenticated with the admin API key.


Make some attributes unretrievable

  'unretrievableAttributes' => [
Did you find this page helpful?