Indexes

List indexes

Return the profile indexes configured in your tenant.

get/indexes

Request

Base URL
https://app.amperity.com/api
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.

limitinteger

Ignored: this endpoint returns every index in one response.

next_tokenstring

Ignored: this endpoint returns every index in one response.

with_totalboolean

Set this value to true to include the total number of indexes. Default: false.

Amperity-Tenantstring required

The ID for the tenant to which a request will be sent.

Api-Versionstring required

Example:2025-07-31

A supported version of the Profile API.

A list of indexes

totalinteger

The total number of indexes that exist

No recorded changes to this operation across all 1 revision of this API.