Profiles

List profiles in an index

Retrieve profiles that match the specified filter criteria

get/indexes/{index-id}/profiles

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/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

index-idstring required

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

Query parameters

limitinteger

The maximum number of profiles to include in a single page of results. Default: 25. Values above 100 return 100.

next_tokenstring

An opaque token that is used to paginate results. Omit the next_token property to return the first page. Use the cursor value for next_token that was returned in a response to view the next page of results.

filterobject

Filter criteria, sent as filter[<attribute>]=<value>, such as filter[first_name]=Daniel&filter[last_name]=Kulhman. Each attribute must be configured as a filter field on the index; any other attribute returns a 400 response. Profiles must match every filter.

Headers

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.

Response

Profiles that match the filter criteria

next_tokenstring

The next token to fetch additional data

Changes

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