Indexes

Get an index by id

Return one profile index configured in your tenant.

get/indexes/{index-id}

Request

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

index-idstring required

The unique identifier for the index, as returned by GET /indexes.

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.

The requested index

created_atstring required

Time when the index was created

descriptionstring required

Description of the index

idstring required

Unique identifier for the index

namestring required

Display name of the index

updated_atstring required

Time when the index was last updated

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