Skip to main content
POST
/
indexes
/
{indexUid}
/
fields
cURL
curl \
  -X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/fields' \
  -H 'Content-Type: application/json'
{
  "results": [
    {
      "name": "title",
      "displayed": {
        "enabled": true
      },
      "searchable": {
        "enabled": true
      },
      "sortable": {
        "enabled": true
      },
      "distinct": {
        "enabled": false
      },
      "rankingRule": {
        "enabled": false,
        "order": []
      },
      "filterable": {
        "enabled": false,
        "sortBy": "count",
        "facetSearch": false,
        "equality": false,
        "comparison": false
      },
      "localized": {
        "locales": []
      }
    },
    {
      "name": "genre",
      "displayed": {
        "enabled": true
      },
      "searchable": {
        "enabled": false
      },
      "sortable": {
        "enabled": false
      },
      "distinct": {
        "enabled": false
      },
      "rankingRule": {
        "enabled": false,
        "order": []
      },
      "filterable": {
        "enabled": true,
        "sortBy": "alpha",
        "facetSearch": true,
        "equality": true,
        "comparison": false
      },
      "localized": {
        "locales": []
      }
    }
  ],
  "offset": 0,
  "limit": 20,
  "total": 2
}

Authorizations

​
Authorization
string
header
required

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

​
indexUid
string
required

Unique identifier of the index whose fields to list.

Body

application/json
​
offset
integer

Number of fields to skip. Defaults to 0.

Required range: x >= 0
​
limit
integer

Maximum number of fields to return. Defaults to 20.

Required range: x >= 0
​
filter
object

Optional filter to restrict which fields are returned (e.g. by attribute patterns or by capability: displayed, searchable, sortable, filterable, etc.).

Response

​
results
object[]
required

Items for the current page.

​
offset
integer
required

Number of items skipped.

Required range: x >= 0
​
limit
integer
required

Maximum number of items returned.

Required range: x >= 0
​
total
integer
required

Total number of items matching the query.

Required range: x >= 0