---
title: "Get location rankings via GET"
method: GET
path: "/home/locations/ranks"
tags: ["Homepage"]
---

# Get location rankings via GET

`GET /home/locations/ranks`

Retrieves a paginated ranking of locations based on their scores, using query parameters for filter criteria.

## Query parameters

- `locationIds` string, nullable
- `businessIds` string, nullable
- `locationGroupIds` string, nullable
- `labels` string, nullable
- `sort` string, required
- `page` integer, required
- `pageSize` integer, required
- `scoreMin` integer, required
- `scoreMax` integer, required
- `normalisedScoreMin` integer, nullable
- `normalisedScoreMax` integer, nullable
- `excludedLocationIds` string, nullable
- `excludedBusinessIds` string, nullable
- `excludedLocationGroupIds` string, nullable
- `excludedLabels` string, nullable
- `filterCategory` string, nullable
- `query` string, nullable

## Response `200`

Successfully retrieved location rankings

- object — Paginated response containing location rankings ordered by score
  - `ranks` object[], required — List of ranked locations
    - `locationId` integer — Location identifier
    - `identifier` string, nullable — External identifier for the location
    - `name` string, nullable — Location name
    - `address` string, nullable — Location address
    - `score` integer — Location score
    - `normalisedScore` integer, nullable — Normalised score with a scale of 0-100. Omitted for non-custom sales partners, whose maxScore is 100 so the normalised score always equals score.
  - `page` integer — Current page number
  - `pageSize` integer — Number of items per page
  - `size` integer — Number of items in the current page
  - `totalCount` integer — Total number of ranked locations

## Other responses

- `400` — Invalid request parameters
- `401` — Unauthorized - missing or invalid user headers

---

[API](https://skmtc.net/uberall/apis/uberall-api.md) · [All operations](https://skmtc.net/uberall/apis/uberall-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uberall/uberall-api/versions/a506e82d7cbe/schema)