---
title: "List indexes"
method: GET
path: "/indexes"
tags: ["Indexes"]
---

# List indexes

`GET /indexes`

## Request

- Base URL: `https://app.amperity.com/api`
- URL: `https://app.amperity.com/api/indexes`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/amperity/apis/amperity-profile-api/docs/indexes/get.ts> (a function with typed inputs; its response is checked against the schema)

Return the profile indexes configured in your tenant.

## Query parameters

- `limit` integer
- `next_token` string
- `with_total` boolean

## Headers

- `Amperity-Tenant` string, required
- `Api-Version` string, required

## Response `200`

A list of indexes

- ListIndexesResponse: Response containing a list of available indexes
  - `data` Index[], required: Every index in the tenant.
    - `created_at` string, required: Time when the index was created
    - `description` string, required: Description of the index
    - `id` string, required: Unique identifier for the index
    - `name` string, required: Display name of the index
    - `updated_at` string, required: Time when the index was last updated
  - `total` integer: The total number of indexes that exist

## Other responses

- `400`: Bad request
- `401`: Authentication Required
- `403`: Not Authorized
- `404`: Not Found
- `405`: Method Not Allowed
- `500`: Internal Error
- `503`: Service Unavailable

---

[API](https://skmtc.dev/amperity/apis/amperity-profile-api.md) - [All operations](https://skmtc.dev/amperity/apis/amperity-profile-api/llms.txt) - [OpenAPI document](https://skmtc.dev/amperity/apis/amperity-profile-api/revisions/95532e60c7f5?raw)