Sign in
Sites

Retrieve Sites

Use this endpoint to retrieve a paginated list of Sites.

get/sites

Query parameters

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

site_idstring

Filter results by the site they belong to

querystring

Filter results by name or ID.

sort_bystring

The field to sort the results by.

sort_by_direction'asc' | 'desc'

The direction in which to sort to the response.

Response

Sites were successfully retrieved.

Example response

{
  "data": [
    {
      "country_code": "GB",
      "currency": "GBP",
      "external_id": "ext-site-london-bridge",
      "frontend_subdomain": "palmtreespa",
      "locale": "en",
      "name": "Palm Tree Spa",
      "organisation_name": "Palm Tree Holdings Ltd.",
      "property_type": "Spa & Leisure Hotel",
      "timezone": "Europe/London"
    }
  ],
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  },
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  }
}

Changes