Sign in
Zones

List zones

Returns a paginated list of Zone objects configured at the given site, ordered by name. Use this to populate a zone picker when configuring rooms, practitioners, or area-booking types.

Requires the RESERVATIONS_VIEW permission on the site.

get/shop/zones

Query parameters

site_idstring required

Filter results by the site they belong to

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

A paginated list of Zone objects configured at the site.

Example response

{
  "data": [
    {
      "id": "5f1234567890abcdef123456",
      "name": "Pool Deck",
      "organisation_id": "22222222-2222-2222-2222-222222222222",
      "site_id": "11111111-1111-1111-1111-111111111111"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.