---
title: "Get an index by id"
method: GET
path: "/indexes/{index-id}"
tags: ["Indexes"]
---

# Get an index by id

`GET /indexes/{index-id}`

## Request

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

Return one profile index configured in your tenant.

## Path parameters

- `index-id` string, required

## Headers

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

## Response `200`

The requested index

- Index: An index item
  - `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

## Other responses

- `400`: Invalid request
- `401`: Authentication Required
- `403`: Not Authorized
- `404`: Index 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)