Skip to main content
GET
/
1
/
clusters
/
mapping
curl
curl --request GET \
  --url 'https://algolia_application_id.algolia.net/1/clusters/mapping?page=0&hitsPerPage=100' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'
{
  "userIDs": [
    {
      "userID": "user1",
      "clusterName": "c1-test",
      "nbRecords": 42,
      "dataSize": 0
    }
  ]
}
Requires Admin API key

Authorizations

​
x-algolia-application-id
string
header
required

Your Algolia application ID.

​
x-algolia-api-key
string
header
required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Query Parameters

​
page
integer | null

Requested page of the API response. If null, the API response is not paginated.

Required range: x >= 0
​
hitsPerPage
integer
default:100

Number of hits per page.

Response

OK

User ID data.

​
userIDs
userID · object[]
required

User IDs.

⌘I