---
title: "Get a paged array of locations"
method: GET
path: "/locations"
tags: ["location"]
---

# Get a paged array of locations

`GET /locations`

Get a paged array of locations

## Query parameters

- `id_gt` integer, nullable — The starting object id of the next page
- `id_lt` integer, nullable — The starting object id of the previous page
- `update_gt` union — Search for objects updated after this date time
  - string
  - string
- `update_lt` union — Search for objects updated before this date time
  - string
  - string
- `include_archived` 'true' | 'false', nullable — Whether archived objects should be retrieved, default is false
- `title` string, nullable — Location title

## Response `200`

A paged array of locations

- object
  - `data` object[], required
    - `id` integer, required — Location id
    - `title` string, required — Location title
    - `abn` string, nullable, required — Business number
    - `address` string, nullable, required — Business number
    - `postalCode` string, nullable, required — Location post code
    - `suburb` string, nullable, required — Location suburb
    - `state` string, nullable, required — Location state
    - `country` string, nullable, required — Location country
    - `phone` string, nullable, required — Location phone number
    - `email` string, nullable, required — Location email
    - `onlineBooking` boolean, nullable — Whether online booking is enabled
    - `timezone` string, nullable, required — Location timezone
    - `archived` boolean, nullable — Whether the location has been archived
    - `associatedServiceIds` integer[], required — Array of service ids associated with this location
    - `createdAt` union — Object creation date time
      - string
      - string
    - `updatedAt` union — Object update date time
      - string
      - string
    - `deletedAt` union, required — Object archived date time
      - string
      - string
      - unknown
  - `links` object, required
    - `previousPage` string — The link to retrieve next page
    - `nextPage` string — The link to retrieve previous page

---

[API](https://skmtc.dev/splose/apis/splose-public-api.md) · [All operations](https://skmtc.dev/splose/apis/splose-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/splose/splose-public-api/revisions/648d60075f00/schema)