---
title: "Get a paginated list of locations with optional filters"
method: GET
path: "/Locations"
tags: ["Locations"]
---

# Get a paginated list of locations with optional filters

`GET /Locations`

## Query parameters

- `page` union
  - integer
  - string, int32
- `pageSize` union
  - integer
  - string, int32
- `isActive` boolean
- `query` string
- `sortBy` string
- `sortOrder` string
- `kind` 'Room' | 'Cage' | 'Run' | 'Ward' — What a `Location` physically is (ITE-710). Exam rooms are where appointments happen and what the flowboard room grid shows; cages, runs and wards are where a hospitalized patient lives for the length of a `HospitalStay`. The admit picker filters on this, and the flowboard keeps hospitalization locations out of its grid. Stored as text; the default keeps every pre-existing location an exam room.

## Response `200`

Paginated list of locations

- LocationListResponseDto
  - `data` LocationResponseDto[]
    - `id` string
    - `name` string
    - `description` string, nullable
    - `isActive` boolean
    - `displayOrder` union
      - integer
      - string, int32
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `isVehicle` boolean
    - `isPersonalVehicle` boolean
    - `allowOnlineBooking` boolean
    - `allowOverbooking` boolean
    - `kind` 'Room' | 'Cage' | 'Run' | 'Ward' — What a `Location` physically is (ITE-710). Exam rooms are where appointments happen and what the flowboard room grid shows; cages, runs and wards are where a hospitalized patient lives for the length of a `HospitalStay`. The admit picker filters on this, and the flowboard keeps hospitalization locations out of its grid. Stored as text; the default keeps every pre-existing location an exam room.
    - `allowedSpeciesIds` string[], nullable — Species IDs allowed at this location. If empty/null, all species are allowed.
  - `totalCount` union
    - integer
    - string, int32
  - `page` union
    - integer
    - string, int32
  - `pageSize` union
    - integer
    - string, int32
  - `totalPages` union
    - integer
    - string, int32

## Changes

- **2026-09-11** `503cd0546309` — 4 info
  - added the new optional `query` request parameter `kind`
  - added the optional property `data/items/kind` to the response with the `200` status (media type: text/plain)
  - added the optional property `data/items/kind` to the response with the `200` status (media type: application/json)
  - added the optional property `data/items/kind` to the response with the `200` status (media type: text/json)

[Change history](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/changes/Locations/get.md)

---

[API](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1.md) · [All operations](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/revisions/652ff1990675?raw)