List user IDs

Lists the userIDs assigned to a multi-cluster application.

GET /1/clusters/mapping

curl

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'

200

{
  "userIDs": [
    {
      "clusterName": "c1-test",
      "dataSize": 0,
      "nbRecords": 42,
      "userID": "user1"
    }
  ]
}

Since it can take a few seconds to get the data from the different clusters, the response isn’t real-time.

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

hitsPerPage · integer · default: 100

Number of hits per page.

page · integer | null

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

Required range: x >= 0

Response

200

application/json

OK

User ID data.

userIDs · userID · object[] · required

User IDs.

Show child attributes