Sites & Organisation

Zones

A Zone is a logical area within a site used to group resources for reservations and reporting (e.g. Pool Deck, Hydrotherapy, Garden Cabanas). Zones are referenced by area-booking types, practitioners, and other bookable resources.

get/shop/zones

List zones

listZones

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.

Query parameters

site_idstringrequired
Filter results by the site they belong to
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
A paginated list of Zone objects configured at the site.
401
The user is unauthenticated
403
The authenticated user does not have permission.

curl "https://api.playground.try.be/shop/zones?site_id=site_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/zones?site_id=site_abc123', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/zones?site_id=site_abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/zones?site_id=site_abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/zones?site_id=site_abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A paginated list of `Zone` objects configured at the site.

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

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

post/shop/zones

Create a zone

createZone

Creates a new Zone at a site. Requires the SETTINGS_MANAGE permission on the target site.

Request body

namestringrequired
Display name for the new zone. Plain text only. Zone names do not need to be unique within a site, but duplicates can make the UI confusing — pick distinct labels where possible.
site_iduuidrequired
ID of the site to create this zone under. The caller's API key must have access to the site and the SETTINGS_MANAGE permission on it.
organisation_iduuidoptional
Optional organisation to attribute the zone to. Defaults to the caller's primary organisation when omitted.

Responses

201
A single Zone.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/zones" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Pool Deck",
  "site_id": "11111111-1111-1111-1111-111111111111",
  "organisation_id": "22222222-2222-2222-2222-222222222222"
}'

const response = await fetch('https://api.playground.try.be/shop/zones', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Pool Deck",
    "site_id": "11111111-1111-1111-1111-111111111111",
    "organisation_id": "22222222-2222-2222-2222-222222222222"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/zones",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Pool Deck",
        "site_id": "11111111-1111-1111-1111-111111111111",
        "organisation_id": "22222222-2222-2222-2222-222222222222"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/zones', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Pool Deck',
            'site_id' => '11111111-1111-1111-1111-111111111111',
            'organisation_id' => '22222222-2222-2222-2222-222222222222'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Pool Deck",
		"site_id": "11111111-1111-1111-1111-111111111111",
		"organisation_id": "22222222-2222-2222-2222-222222222222",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/zones", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `Zone`.

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

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/zones/{zoneId}

Retrieve a zone

getZone

Returns a single Zone by ID. Requires the RESERVATIONS_VIEW permission on the zone's site.

Path parameters

zoneIdobject-idrequired
The unique identifier of the Zone.

Responses

200
A single Zone.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/zones/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/zones/abc123', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/zones/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/zones/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/zones/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `Zone`.

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

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

put/shop/zones/{zoneId}

Update a zone

updateZone

Updates the name of an existing Zone. Requires the SETTINGS_MANAGE permission on the zone's site.

Path parameters

zoneIdobject-idrequired
The unique identifier of the Zone.

Request body

namestringrequired
New display name for the zone.

Responses

200
A single Zone.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/zones/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Pool Deck"
}'

const response = await fetch('https://api.playground.try.be/shop/zones/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Pool Deck"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/zones/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Pool Deck"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/zones/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Pool Deck'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Pool Deck",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/zones/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `Zone`.

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

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/zones/{zoneId}

Delete a zone

deleteZone

Removes a Zone. Resources that referenced the zone retain the (now-invalid) ID until their next update — the booking engine treats missing zones as unrestricted. Requires the SETTINGS_MANAGE permission on the zone's site.

Path parameters

zoneIdobject-idrequired
The unique identifier of the Zone.

Responses

204
Zone deleted successfully.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/zones/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/zones/abc123', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/shop/zones/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/shop/zones/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/shop/zones/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Zone deleted successfully.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/zones/{zoneId}/copy

Duplicate a Zone

copyZone

Creates a copy of an existing Zone. Any properties supplied in the request body are overlaid on the source values, letting you rename the copy or move it to a different site without rebuilding from scratch. Properties omitted from the body are inherited from the original verbatim.

Requires the SETTINGS_MANAGE permission on the target site.

Path parameters

zoneIdobject-idrequired
The unique identifier of the Zone.

Request body

idobject-idrequired
Unique identifier for the zone.
namestringrequired
Display name for the zone, shown wherever zones are listed or filtered. Plain text only.
organisation_iduuidrequired
ID of the organisation that owns this zone. Inherited from the site on create.
site_iduuidrequired
ID of the site this zone belongs to.

Responses

201
A single Zone.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/zones/abc123/copy" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "5f1234567890abcdef123456",
  "name": "Pool Deck",
  "organisation_id": "22222222-2222-2222-2222-222222222222",
  "site_id": "11111111-1111-1111-1111-111111111111"
}'

const response = await fetch('https://api.playground.try.be/shop/zones/abc123/copy', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "id": "5f1234567890abcdef123456",
    "name": "Pool Deck",
    "organisation_id": "22222222-2222-2222-2222-222222222222",
    "site_id": "11111111-1111-1111-1111-111111111111"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/zones/abc123/copy",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "id": "5f1234567890abcdef123456",
        "name": "Pool Deck",
        "organisation_id": "22222222-2222-2222-2222-222222222222",
        "site_id": "11111111-1111-1111-1111-111111111111"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/zones/abc123/copy', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'id' => '5f1234567890abcdef123456',
            'name' => 'Pool Deck',
            'organisation_id' => '22222222-2222-2222-2222-222222222222',
            'site_id' => '11111111-1111-1111-1111-111111111111'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"id": "5f1234567890abcdef123456",
		"name": "Pool Deck",
		"organisation_id": "22222222-2222-2222-2222-222222222222",
		"site_id": "11111111-1111-1111-1111-111111111111",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/zones/abc123/copy", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `Zone`.

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

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}