---
title: "Retrieve Sites"
method: GET
path: "/sites"
tags: ["Sites"]
---

# Retrieve Sites

`GET /sites`

Use this endpoint to retrieve a paginated list of `Site`s.

## Query parameters

- `page` integer
- `per_page` integer
- `site_id` string
- `query` string
- `sort_by` string
- `sort_by_direction` 'asc' | 'desc'

## Response `200`

Sites were successfully retrieved.

- object
  - `data` Site[], required
    - `id` string, uuid, required — The ID of the site
    - `billing_customer_id` string, required
    - `brand_id` string, uuid, required — The ID of the `Brand` the `Site` belongs to.
    - `brand_name` string, required — The name of the `Brand` the `Site` belongs to.
    - `country_code` string, nullable, required — The country code of the site
    - `created_at` string, date-time, required — The date and time that the site was created
    - `onboarding_completed_at` string, date-time, nullable, required — The date and time that the site's onboarding was completed
    - `currency` string, required — The currency of the site. See [Supported Currencies](/endpoints/Meta#listMetaSupportedCurrencies) for a list of supported currencies.
    - `external_id` string, nullable, required — An external ID for the site This can be used to link the site to an external system.
    - `frontend_subdomain` string, required — The subdomain of the site's frontend
    - `is_read_only` boolean, required — Are billing details read-only.
    - `locale` string, required — The locale of the site. See [Supported Locales](/endpoints/Meta#listMetaSupportedLocales) for a list of supported locales.
    - `name` string, required — Display name of the site. Shown to customers in the storefront, in the admin UI, on receipts, and on communications. Trimmed; 1-120 characters, must not contain HTML.
    - `organisation_id` string, uuid, required — The ID of the organisation that the site belongs to
    - `organisation_name` string, required — The name of the organisation that the site belongs to
    - `property_type` 'Spa & Leisure Hotel' | 'Spa Hotel' | 'Spa Hotel & Golf' | 'Standalone Leisure' | 'Standalone Spa' | 'Other', required — The type of property the site is.
    - `timezone` string, nullable, required — The site's local timezone as an IANA zone identifier (e.g. `Europe/London`, `America/New_York`). All schedule, opening hours and reporting figures are interpreted in this zone, and the value is used to convert UTC timestamps in API responses into local times for display.
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request

## Other responses

- `401` — The user is unauthenticated
- `403` — The authenticated user does not have permission.

---

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