---
title: "List indexes"
method: GET
path: "/api/index"
tags: ["Index"]
---

# List indexes

`GET /api/index`

## Query parameters

- `page_num` integer
- `page_size` integer
- `sort_by` string
- `desc` boolean
- `name` string

## Response `200`

OK

- IndexIndexListResponse
  - `list` CoreIndex[]
  - `page` MetaPage
    - `page_num` integer
    - `page_size` integer
    - `total` integer

## Changes

- **2022-08-06** `64901d9f1a5b` — 1 breaking, 7 info
  - the response's body type changed from `array` to `object` for status `200`
  - added the new optional `query` request parameter `desc`
  - added the new optional `query` request parameter `name`
  - added the new optional `query` request parameter `page_num`
  - …4 more
- **2022-06-24** `b796c7453ce7` — 1 breaking, 7 warning
  - the response's body type changed from `object` to `array` for status `200`
  - deleted the `query` request parameter `desc`
  - deleted the `query` request parameter `name`
  - deleted the `query` request parameter `page_num`
  - …4 more

[Change history](https://skmtc.dev/zincsearch/apis/zinc-search-engine-api/changes/api/index/get.md)

---

[API](https://skmtc.dev/zincsearch/apis/zinc-search-engine-api.md) · [All operations](https://skmtc.dev/zincsearch/apis/zinc-search-engine-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zincsearch/zinc-search-engine-api/revisions/c7ce1991bb9a/schema)