Profiles

Get a profile by primary key

Retrieve a specific profile by its ID

get/indexes/{index-id}/profiles/{profile-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/profiles/:profile-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.

profile-idstring required

The profile's ID: the value of the index's ID field, returned as id by GET /indexes/{index-id}/profiles.

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 profile

attributesListProfilesResponseDataAttributes required

A map of key-value profile attributes. The specific keys and values depend on the index configuration.

idstring required

The id of a given profile

index_idstring required

The id of the index

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