Get a permissions index
The GetIndex API returns the details of a specific permissions index within a store.
The response includes the index’s status, its associated authorization models, its tracked relations, and its statistics. An index’s statistics include its total ingested changes, total expansions, and a freshness timestamp indicating how up-to-date the index is.
To retrieve data from an index, see the ReadExpansions API.
Example
Retrieve an index
To get the details of index 01YCP46JKYM8FJCQ37NMBYHE5X in store 01G5JAVJ41T49E9TT3SKVS7X1J, call the GetIndex API. The API will return the index details:
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Response
A successful response.