GET /indexes/{id}¶
Use the GET /indexes/{id} endpoint to return the details for a specific index ID.
Prerequisites¶
Base URL¶
Direct all requests to the GET /indexes/{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} endpoint is similar to:
curl --request GET \
'https://tenant.amperity.com/api/indexes \
?index-id={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 following table describes the parameters that may be used with the GET /indexes/{id} endpoint.
Parameter |
Description |
---|---|
index-id |
String. Required. The unique identifier for the index. |
Request examples¶
The following examples show how to send requests to the GET /indexes/{id} endpoint.
The following example shows how to use cURL to send a request to the GET /indexes/{id} endpoint.
curl --request GET \
'https://tenant.amperity.com/api/indexes/ \
?index-id={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} 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 index ID.
1{
2 "id": "{id}",
3 "name": "{name of index}",
4 "description": "{description of index}",
5 "created_at": "{timestamp}",
6 "updated_at": "{timestamp}"
7}
For example:
1{
2 "id": "idx-xyz789",
3 "name": "loyalty_members",
4 "description": "Profiles from the loyalty program",
5 "created_at": "2025-07-30T22:24:01.798Z",
6 "updated_at": "2025-07-30T22:24:01.798Z"
7}
Response parameters¶
A 200 OK response contains the following parameters.
Parameter |
Description |
---|---|
created_at |
The timestamp at which the index was created. |
description |
The description of the index. |
id |
The unique ID for the index. |
name |
The name of the index. |
updated_at |
The timestamp at which the index was last updated. |
404 Not Found¶
1{
2 "status": 404,
3 "message": "The requested entity does not exist.",
4 "request_id": "7d2f4a3e-1234-5678-90ab-cd3f",
5 "trace_id": "1c9d3asdfasdf9b0c1d2e3f4"
6}