GET /indexes/{id}/profiles/{id}¶
Use the GET /indexes/{id}/profiles/{id} endpoint to return a specific customer profile.
Prerequisites¶
Base URL¶
Direct all requests to the GET /indexes/{id}/profiles/{id} endpoint to the following base URL:
https://{tenant-id}.amperity.com/api/indexes/
Rate limit¶
A rate limit is the number of requests that may be made to the Amperity API in a given time period.
Requests¶
A request to the GET /indexes/{id}/profiles/{id} endpoint is similar to:
curl --request GET \
'https://tenant.amperity.com/api/indexes/{id}/profiles/{id} \
--header 'amperity-tenant: {tenant}' \
--header 'api-version: 2025-07-31' \
--header 'Authorization: Bearer {token}'
(This example is formatted for readability in a narrow page layout.)
Request parameters¶
The GET /indexes/{id}/profiles/{id} endpoint does not have any request parameters.
Request examples¶
The following examples show how to send requests to the GET /indexes/{id}/profiles/{id} endpoint.
The following example shows how to use cURL to send a request to the GET /indexes/{id}/profiles/{id} endpoint.
curl --request GET \
'https://tenant.amperity.com/api/indexes/{id}/profiles/{id} \
--header 'amperity-tenant: {tenant}' \
--header 'api-version: 2025-07-31' \
--header 'Authorization: Bearer {token}'
(This example is formatted for readability in a narrow page layout.)
Responses¶
A response from the GET /indexes/{id}/profiles/{id} endpoint will match an HTTP status code. A 200 response will contain the results set. A 4xx response indicates an issue with the configuration of your request. A 5xx response indicates that the endpoint is unavailable.
200 OK¶
The 200 response returns a specific customer profile.
1{
2 "id": "{profile_id}",
3 "index_id": "{index_id}",
4 "attributes": [
5 {
6 "attribute": "value",
7 "attribute": "value"
8 },
9 ]
10}
where the contents of attributes
depend on the attributes that are in the index. For example:
1{
2 "id": "{profile_id}",
3 "index_id": "{index_id}",
4 "attributes": [
5 {
6 "first_name": "Daniel",
7 "last_name": "Kuhlman",
8 "email": "danielkuhlman@email.com",
9 "loyalty_id": "123456789-0"
10 },
11 ]
12}
Response parameters¶
A 200 OK response contains the following parameters.
Parameter |
Description |
---|---|
atttributes |
A JSON array of attributes for a profile in an index. The attributes that are returned are specific to the index. For example: 1{
2 "id": "{profile_id}",
3 "index_id": "{index_id}",
4 "attributes": [
5 {
6 "first_name": "Daniel",
7 "last_name": "Kuhlman",
8 "email": "danielkuhlman@email.com",
9 "loyalty_id": "123456789-0"
10 },
11 ]
12}
|
id |
The unique ID for the customer profile. |
index_id |
The unique ID for the profile index. |