---
title: "Get list of all indexes"
method: GET
path: "/v3/index"
tags: ["Search & Match"]
---

# Get list of all indexes

`GET /v3/index`

Returns all the indexes

## Query parameters

- `offset` integer
- `limit` integer
- `document_type` 'resumes' | 'job_descriptions'
- `name` string

## Response `200`

All indexes for user

- object
  - `count` integer, required — Number of items in results.
  - `next` string, nullable — URL to request next page of results.
  - `previous` string, nullable — URL to request previous page of results.
  - `results` Index[], required
    - `name` string, required — Unique index name
    - `docType` 'resumes' | 'job_descriptions', required
    - `user` IndexUser, required — The user who created this index
      - `id` integer, required — Uniquely identify a user.
      - `name` string, required
      - `email` string, required
      - `avatar` string, nullable, required — URL of the user's avatar.

## Other responses

- `400` — Bad request. If it is a validation error will contain a list of each invalid field
- `401` — Authorisation error
- `default` — UnexpectedError

---

[API](https://skmtc.net/affinda/apis/affinda-api-2.md) · [All operations](https://skmtc.net/affinda/apis/affinda-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/affinda/affinda-api-2/versions/6772e50cb58e/schema)