GET /v1/indexes/products 🔒 Bearer

Get an index

Fetch one index by name, with its schema and live counts.

Returns one index by name. Same shape as the entries in List indexes, plus the full schema.

# Path parameters

Name Type Description
name string The index name.

# Response

{
  "data": {
    "id": 42,
    "name": "products",
    "records_count": 25964,
    "status": "active",
    "schema": {
      "fields": [
        { "name": "title",    "type": "string" },
        { "name": "brand",    "type": "string", "facet": true },
        { "name": "category", "type": "string", "facet": true },
        { "name": "price",    "type": "float",  "facet": true }
      ],
      "default_sorting_field": "price"
    },
    "typo_config": { "num_typos": 2, "min_word_length_for_1_typo": 4, "min_word_length_for_2_typos": 7 }
  }
}

Returns 404 with code SK-SE-404 if the index does not exist or your key doesn't have access to it.

esc
GET /v1/indexes/products