---
title: "List profiles in an index"
method: GET
path: "/indexes/{index-id}/profiles"
tags: ["Profiles"]
---

# List profiles in an index

`GET /indexes/{index-id}/profiles`

## Request

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

Retrieve profiles that match the specified filter criteria

## Path parameters

- `index-id` string, required

## Query parameters

- `limit` integer
- `next_token` string
- `filter` object

## Headers

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

## Response `200`

Profiles that match the filter criteria

- ListProfilesResponse: A page of profiles that match the filter criteria.
  - `data` ProfileResponse[], required: The profiles on this page.
    - `attributes` ListProfilesResponseDataAttributes, required: A map of key-value profile attributes. The specific keys and values depend on the index configuration.
    - `id` string, required: The id of a given profile
    - `index_id` string, required: The id of the index
  - `next_token` string: The next token to fetch additional data

## Other responses

- `400`: Invalid 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)