Sites & Organisation

Shop

Shopfront endpoints.

get/shop/shop/offerings/{offeringType}/{offeringId}

List storefront appointment tags

listShopAppointmentTags

Returns every AppointmentTag configured at the organisation level. Tags label appointment types for the storefront UI (e.g. "couples", "mens") so customers can filter by interest.

Tags are organisation-level, not site-level — pass the organisation_id whose sites you're rendering for.

Query parameters

organisation_iduuidrequired
ID of the organisation to scope the listing to. Categories and appointment tags are organisation-level, not site-level — pass the org that owns the relevant sites.

Responses

200
A list of AppointmentTags for the organisation.
401
The user is unauthenticated
422
The request didn't pass validation

curl "https://api.playground.try.be/shop/shop/appointment-tags?organisation_id=00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/shop/appointment-tags?organisation_id=00000000-0000-0000-0000-000000000000', {
  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/shop/appointment-tags?organisation_id=00000000-0000-0000-0000-000000000000",
    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/shop/appointment-tags?organisation_id=00000000-0000-0000-0000-000000000000', [
    '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/shop/appointment-tags?organisation_id=00000000-0000-0000-0000-000000000000", 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 list of `AppointmentTag`s for the organisation.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "name": "Alex Morgan",
      "color": "#FF0066",
      "organisation_id": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

{
  "message": "Unauthenticated"
}

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

get/shop/shop/appointments

List storefront appointment types

listShopAppointmentTypes

Returns the customer-facing AppointmentTypes at the given site — only those with visibility=public or visibility=link_only. Use this to render the appointment menu on the booking storefront.

For staff-facing listings (including hidden appointment types) use GET /shop/appointment-types instead.

Query parameters

site_idstringrequired
Filter results by the site they belong to

Responses

200
A list of public-facing AppointmentTypes.
401
The user is unauthenticated
422
The request didn't pass validation

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

const response = await fetch('https://api.playground.try.be/shop/shop/appointments?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/shop/appointments?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/shop/appointments?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/shop/appointments?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 list of public-facing `AppointmentType`s.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "allocate_multi_capacity_rooms": false,
      "canada_rmt_eligible": false,
      "categories": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "name": "Massages",
          "voucher_applicable": false
        }
      ],
      "category_ids": [
        "64a9f3b2c3d8e1f4a5b6c7d8"
      ],
      "contraindications": [
        {
          "condition": "blood_pressure",
          "indication": "conditional",
          "notes": "Free-form text from the resource."
        }
      ],
      "cross_sell_offerings": [
        {
          "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ],
      "currency": "gbp",
      "customer_cancellation_min_duration": "P7D",
      "customer_cancellation_permitted": "allowed",
      "customers_only": false,
      "description": "Free-form text from the resource.",
      "durations": [
        1
      ],
      "end_buffer": 1,
      "enquiries_enabled": false,
      "external_id": "00000000-0000-0000-0000-000000000000",
      "equipment_ids": [
        "64a9f3b2c3d8e1f4a5b6c7d8"
      ],
      "image": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "include_pricing_on_calendar": false,
      "max_advance_bookings_interval": "string",
      "max_guests": 1,
      "practitioners_per_guest": 1,
      "max_per_basket": 1,
      "max_per_guest": 1,
      "members_only": false,
      "membership_booking_windows": [
        {
          "membership_type_id": "00000000-0000-0000-0000-000000000000",
          "max_advance_bookings_interval": "P2W",
          "min_advance_bookings_interval": "P2D"
        }
      ],
      "membership_booking_windows_enabled": false,
      "meta": {
        "description": "Free-form text from the resource.",
        "title": "string"
      },
      "min_advance_bookings_interval": "string",
      "min_guests": 1,
      "name": "Alex Morgan",
      "offered_online": false,
      "permitted_membership_type_ids": [
        "64a9f3b2c3d8e1f4a5b6c7d8"
      ],
      "private": false,
      "product_code": "string",
      "practitioner_ids": [
        "64a9f3b2c3d8e1f4a5b6c7d8"
      ],
      "price_rules": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "appointment_type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "date_from": "2026-01-15",
          "date_to": "2026-01-15",
          "duration": 1,
          "price": 1,
          "time_from": "12:00",
          "time_to": "16:00",
          "weekdays": [
            "string"
          ]
        }
      ],
      "related_retail_offerings": [
        {
          "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ],
      "revenue_centre": "string",
      "room_ids": [
        "64a9f3b2c3d8e1f4a5b6c7d8"
      ],
      "shop_practitioner_selection": "by_name",
      "site_ids": [
        "64a9f3b2c3d8e1f4a5b6c7d8"
      ],
      "start_time_interval": 1,
      "tag_ids": [
        "64a9f3b2c3d8e1f4a5b6c7d8"
      ],
      "tags": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Alex Morgan",
          "organisation_id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "upsell_offerings": [
        {
          "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ],
      "visibility": "public",
      "deleted_at": "2025-02-04T12:00:00+01:00",
      "updated_at": "2025-02-04T12:00:00+01:00"
    }
  ]
}

{
  "message": "Unauthenticated"
}

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

get/shop/shop/categories

Returns every customer-facing Offering at the given site — appointments, area bookings, packages, products, and sessions — in the order they should appear in the storefront listing. The shape of each item depends on offering_type.

Optional filters narrow the listing by category_id, partner_id, or date (only offerings with availability on the given day are returned). When customer / frontend-guard auth is present, the result accounts for the customer's coupon codes when calculating displayed pricing.

This is the public storefront endpoint; results are filtered to visibility=public and visibility=link_only records.

Query parameters

site_idstringrequired
Filter results by the site they belong to
datedateoptional
Optional date (YYYY-MM-DD) used to scope the listing to offerings that have availability on that day.
category_idstringoptional
Filter the result to a single offering category.
partner_idstringoptional
Restrict the listing to offerings the given partner is allowed to sell. Pass the partner key (e.g. ota).

Responses

200
A list of public-facing Offerings at the given site. Each entry can be an appointment, area booking, package, session, or product — the concrete shape varies per offering type.
400
The request failed.
401
The user is unauthenticated
404
The resource couldn't be found
422
The request didn't pass validation

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

const response = await fetch('https://api.playground.try.be/shop/shop/offerings?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/shop/offerings?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/shop/offerings?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/shop/offerings?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 list of public-facing `Offering`s at the given site. Each entry can be an appointment, area booking, package, session, or product — the concrete shape varies per offering type.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "categories": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "name": "Alex Morgan"
        }
      ],
      "currency": "gbp",
      "description": "Free-form text from the resource.",
      "discounts": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "amount_type": "monetary",
          "applicable_for": "app_and_booking_engine",
          "applied_at": "2026-01-15T09:30:00+00:00",
          "applied_by": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "avatar": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "email": "guest@example.com",
            "first_name": "Jane",
            "full_name": "Jane Smith",
            "last_name": "Smith"
          },
          "calculated_amount": 150,
          "coupon": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "code": "FIVEOFF",
            "name": "April special",
            "description": "Get 10% off all treatments booked in April.",
            "customer_credit_id": "00000000-0000-0000-0000-000000000000"
          },
          "coupon_code_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "currency": "gbp",
          "discount_amount": 15,
          "discount_type_code": "SUMMER23",
          "reason_code": "general",
          "site_id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "duration": 1,
      "external_id": "00000000-0000-0000-0000-000000000000",
      "has_availability": true,
      "image": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "max_guests": 1,
      "min_guests": 1,
      "name": "Alex Morgan",
      "price_from": 1,
      "price_to": 1,
      "type": "appointment"
    }
  ]
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

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

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

get/shop/shop/offerings/{offeringType}/{offeringId}/cross-sell

List cross-sell offerings for an offering

listShopOfferingCrossSells

Returns the configured cross-sell offerings for the given Offering. Cross-sells are surface elsewhere in the booking flow (e.g. "Customers also booked...") to drive add-on revenue. The response shape is identical to GET /shop/shop/offerings.

Only appointment, package, and session offering types expose cross-sells; other types return 404.

Path parameters

offeringTypestringrequired
The type of Offering.
Possible values:appointmentappointment_enquiryarea_bookingcoursehotel_room_reservationmembershippackageproductsessiontable_reservationvoucher
offeringIdobject-idrequired
The ID of the Offering.

Responses

200
A list of public-facing Offerings at the given site. Each entry can be an appointment, area booking, package, session, or product — the concrete shape varies per offering type.
401
The user is unauthenticated
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/shop/shop/offerings/appointment/abc123/cross-sell', {
  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/shop/offerings/appointment/abc123/cross-sell",
    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/shop/offerings/appointment/abc123/cross-sell', [
    '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/shop/offerings/appointment/abc123/cross-sell", 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 list of public-facing `Offering`s at the given site. Each entry can be an appointment, area booking, package, session, or product — the concrete shape varies per offering type.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "categories": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "name": "Alex Morgan"
        }
      ],
      "currency": "gbp",
      "description": "Free-form text from the resource.",
      "discounts": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "amount_type": "monetary",
          "applicable_for": "app_and_booking_engine",
          "applied_at": "2026-01-15T09:30:00+00:00",
          "applied_by": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "avatar": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "email": "guest@example.com",
            "first_name": "Jane",
            "full_name": "Jane Smith",
            "last_name": "Smith"
          },
          "calculated_amount": 150,
          "coupon": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "code": "FIVEOFF",
            "name": "April special",
            "description": "Get 10% off all treatments booked in April.",
            "customer_credit_id": "00000000-0000-0000-0000-000000000000"
          },
          "coupon_code_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "currency": "gbp",
          "discount_amount": 15,
          "discount_type_code": "SUMMER23",
          "reason_code": "general",
          "site_id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "duration": 1,
      "external_id": "00000000-0000-0000-0000-000000000000",
      "has_availability": true,
      "image": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "max_guests": 1,
      "min_guests": 1,
      "name": "Alex Morgan",
      "price_from": 1,
      "price_to": 1,
      "type": "appointment"
    }
  ]
}

{
  "message": "Unauthenticated"
}

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

get/shop/shop/offerings/{offeringType}/{offeringId}/up-sell

List up-sell offerings for an offering

listShopOfferingUpSells

Returns the configured up-sell offerings for the given Offering. Up-sells are surfaced at checkout ("Upgrade to...") to encourage customers to choose a higher-margin alternative. The response shape is identical to GET /shop/shop/offerings.

Only appointment, package, and session offering types expose up-sells; other types return 404.

Path parameters

offeringTypestringrequired
The type of Offering.
Possible values:appointmentappointment_enquiryarea_bookingcoursehotel_room_reservationmembershippackageproductsessiontable_reservationvoucher
offeringIdobject-idrequired
The ID of the Offering.

Responses

200
A list of public-facing Offerings at the given site. Each entry can be an appointment, area booking, package, session, or product — the concrete shape varies per offering type.
401
The user is unauthenticated
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/shop/shop/offerings/appointment/abc123/up-sell', {
  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/shop/offerings/appointment/abc123/up-sell",
    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/shop/offerings/appointment/abc123/up-sell', [
    '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/shop/offerings/appointment/abc123/up-sell", 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 list of public-facing `Offering`s at the given site. Each entry can be an appointment, area booking, package, session, or product — the concrete shape varies per offering type.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "categories": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "name": "Alex Morgan"
        }
      ],
      "currency": "gbp",
      "description": "Free-form text from the resource.",
      "discounts": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "amount_type": "monetary",
          "applicable_for": "app_and_booking_engine",
          "applied_at": "2026-01-15T09:30:00+00:00",
          "applied_by": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "avatar": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "email": "guest@example.com",
            "first_name": "Jane",
            "full_name": "Jane Smith",
            "last_name": "Smith"
          },
          "calculated_amount": 150,
          "coupon": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "code": "FIVEOFF",
            "name": "April special",
            "description": "Get 10% off all treatments booked in April.",
            "customer_credit_id": "00000000-0000-0000-0000-000000000000"
          },
          "coupon_code_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "currency": "gbp",
          "discount_amount": 15,
          "discount_type_code": "SUMMER23",
          "reason_code": "general",
          "site_id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "duration": 1,
      "external_id": "00000000-0000-0000-0000-000000000000",
      "has_availability": true,
      "image": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "max_guests": 1,
      "min_guests": 1,
      "name": "Alex Morgan",
      "price_from": 1,
      "price_to": 1,
      "type": "appointment"
    }
  ]
}

{
  "message": "Unauthenticated"
}

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

get/shop/shop/practitioners

List storefront practitioners

listShopPractitioners

Returns every Practitioner working at the given site, with only the public-facing fields (name, profile photo, bio, title, pronouns). Used to populate practitioner pickers and "Meet the team" pages on the booking storefront.

The result is unpaginated and not site-permission gated — it mirrors what a public visitor sees in the storefront UI.

Query parameters

site_idstringrequired
Filter results by the site they belong to

Responses

200
A list of Practitioners with public-facing fields suitable for the booking storefront.
401
The user is unauthenticated
422
The request didn't pass validation

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

const response = await fetch('https://api.playground.try.be/shop/shop/practitioners?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/shop/practitioners?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/shop/practitioners?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/shop/practitioners?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 list of `Practitioner`s with public-facing fields suitable for the booking storefront.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "name": "Alex Morgan",
      "image_url": "https://example.com",
      "bio": "string",
      "title": "string",
      "pronouns": "string"
    }
  ]
}

{
  "message": "Unauthenticated"
}

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

post/shop/shop/practitioners

Create a storefront practitioner

createShopPractitioner

Creates a new Practitioner from the storefront-facing API. The body uses the same Practitioner shape as the admin endpoint; this route exists for legacy storefront integrations that already target /shop/shop/practitioners instead of the canonical /shop/practitioners.

Requires the SETTINGS_MANAGE permission on each site listed in site_ids.

Request body

idobject-idrequired
Stable identifier for the practitioner. Used when assigning sessions, appointments and rotas to the practitioner, and when the booking storefront resolves a slot to a specific staff member.
appointment_restrictionsobject[]required
avatarobjectoptional
can_offer_tagsstring[]required
genderstringoptionalnullable
Self-identified gender of the practitioner, surfaced to guests who filter the booking storefront by practitioner gender. Free text — common values are female, male and non-binary. null when the practitioner hasn't supplied a value.
namestringrequired
Public display name of the practitioner. Shown to guests on the booking storefront and on receipts. Should be the name the practitioner wants to appear in front of guests — typically first name plus last initial or full name.
organisation_iduuidrequired
Organisation the practitioner belongs to. Practitioners are scoped to a single organisation and are not visible to API callers from other organisations.
site_idsstring[]required
tag_idsstring[]required
tagsobject[]required
zonesobject[]required
user_iduuidrequirednullable
Staff User linked to this practitioner record, if any. Linking lets the user manage their own rota and view their appointments from the staff console. null for practitioners that don't have a login account.
created_atdate-timerequired
When then resource was created.
updated_atdate-timerequired
When then resource was last updated.

Responses

201
The practitioner was created.
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/shop/practitioners" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "5dcb47800000000000000000",
  "appointment_restrictions": [
    {
      "id": "5dcb47800000000000000011",
      "applies_to_type": "specific",
      "appointment_type_ids": [
        "5dcb47800000000000000010"
      ],
      "appointment_types": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Alex Morgan"
        }
      ],
      "categories": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Alex Morgan"
        }
      ],
      "category_ids": [
        "5dcb47800000000000000010"
      ],
      "date_from": "2020-06-20",
      "date_to": "2020-06-20",
      "max_duration": 180,
      "occupied_mins": 60,
      "type": "cannot_offer"
    }
  ],
  "avatar": {
    "id": "00000000-0000-0000-0000-000000000000",
    "file_name": "super-cool-photo.jpg",
    "mime_type": "image/jpeg",
    "original_url": "https://example.com/media/super-cool-photo.jpg",
    "size": 84256,
    "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
  },
  "can_offer_tags": [
    "string"
  ],
  "gender": "female",
  "name": "Jane Doe",
  "organisation_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
  "site_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "tag_ids": [
    "string"
  ],
  "tags": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Alex Morgan",
      "organisation_id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "zones": [
    {
      "id": "5f1234567890abcdef123456",
      "name": "Pool Deck",
      "organisation_id": "22222222-2222-2222-2222-222222222222",
      "site_id": "11111111-1111-1111-1111-111111111111"
    }
  ],
  "user_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
  "created_at": "2025-02-04T12:00:00+01:00",
  "updated_at": "2025-02-04T12:00:00+01:00"
}'

const response = await fetch('https://api.playground.try.be/shop/shop/practitioners', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "id": "5dcb47800000000000000000",
    "appointment_restrictions": [
      {
        "id": "5dcb47800000000000000011",
        "applies_to_type": "specific",
        "appointment_type_ids": [
          "5dcb47800000000000000010"
        ],
        "appointment_types": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "Alex Morgan"
          }
        ],
        "categories": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "Alex Morgan"
          }
        ],
        "category_ids": [
          "5dcb47800000000000000010"
        ],
        "date_from": "2020-06-20",
        "date_to": "2020-06-20",
        "max_duration": 180,
        "occupied_mins": 60,
        "type": "cannot_offer"
      }
    ],
    "avatar": {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "can_offer_tags": [
      "string"
    ],
    "gender": "female",
    "name": "Jane Doe",
    "organisation_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
    "site_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "tag_ids": [
      "string"
    ],
    "tags": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Alex Morgan",
        "organisation_id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "zones": [
      {
        "id": "5f1234567890abcdef123456",
        "name": "Pool Deck",
        "organisation_id": "22222222-2222-2222-2222-222222222222",
        "site_id": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "user_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
    "created_at": "2025-02-04T12:00:00+01:00",
    "updated_at": "2025-02-04T12:00:00+01:00"
  }),
})

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/shop/practitioners",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "id": "5dcb47800000000000000000",
        "appointment_restrictions": [
            {
                "id": "5dcb47800000000000000011",
                "applies_to_type": "specific",
                "appointment_type_ids": [
                    "5dcb47800000000000000010"
                ],
                "appointment_types": [
                    {
                        "id": "00000000-0000-0000-0000-000000000000",
                        "name": "Alex Morgan"
                    }
                ],
                "categories": [
                    {
                        "id": "00000000-0000-0000-0000-000000000000",
                        "name": "Alex Morgan"
                    }
                ],
                "category_ids": [
                    "5dcb47800000000000000010"
                ],
                "date_from": "2020-06-20",
                "date_to": "2020-06-20",
                "max_duration": 180,
                "occupied_mins": 60,
                "type": "cannot_offer"
            }
        ],
        "avatar": {
            "id": "00000000-0000-0000-0000-000000000000",
            "file_name": "super-cool-photo.jpg",
            "mime_type": "image/jpeg",
            "original_url": "https://example.com/media/super-cool-photo.jpg",
            "size": 84256,
            "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
        },
        "can_offer_tags": [
            "string"
        ],
        "gender": "female",
        "name": "Jane Doe",
        "organisation_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
        "site_ids": [
            "00000000-0000-0000-0000-000000000000"
        ],
        "tag_ids": [
            "string"
        ],
        "tags": [
            {
                "id": "00000000-0000-0000-0000-000000000000",
                "name": "Alex Morgan",
                "organisation_id": "00000000-0000-0000-0000-000000000000"
            }
        ],
        "zones": [
            {
                "id": "5f1234567890abcdef123456",
                "name": "Pool Deck",
                "organisation_id": "22222222-2222-2222-2222-222222222222",
                "site_id": "11111111-1111-1111-1111-111111111111"
            }
        ],
        "user_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
        "created_at": "2025-02-04T12:00:00+01:00",
        "updated_at": "2025-02-04T12:00:00+01:00"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/shop/practitioners', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'id' => '5dcb47800000000000000000',
            'appointment_restrictions' => [
                [
                    'id' => '5dcb47800000000000000011',
                    'applies_to_type' => 'specific',
                    'appointment_type_ids' => [
                        '5dcb47800000000000000010'
                    ],
                    'appointment_types' => [
                        [
                            'id' => '00000000-0000-0000-0000-000000000000',
                            'name' => 'Alex Morgan'
                        ]
                    ],
                    'categories' => [
                        [
                            'id' => '00000000-0000-0000-0000-000000000000',
                            'name' => 'Alex Morgan'
                        ]
                    ],
                    'category_ids' => [
                        '5dcb47800000000000000010'
                    ],
                    'date_from' => '2020-06-20',
                    'date_to' => '2020-06-20',
                    'max_duration' => 180,
                    'occupied_mins' => 60,
                    'type' => 'cannot_offer'
                ]
            ],
            'avatar' => [
                'id' => '00000000-0000-0000-0000-000000000000',
                'file_name' => 'super-cool-photo.jpg',
                'mime_type' => 'image/jpeg',
                'original_url' => 'https://example.com/media/super-cool-photo.jpg',
                'size' => 84256,
                'url' => 'https://example.com/media/super-cool-photo-thumbnail@2x.jpg'
            ],
            'can_offer_tags' => [
                'string'
            ],
            'gender' => 'female',
            'name' => 'Jane Doe',
            'organisation_id' => '5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d',
            'site_ids' => [
                '00000000-0000-0000-0000-000000000000'
            ],
            'tag_ids' => [
                'string'
            ],
            'tags' => [
                [
                    'id' => '00000000-0000-0000-0000-000000000000',
                    'name' => 'Alex Morgan',
                    'organisation_id' => '00000000-0000-0000-0000-000000000000'
                ]
            ],
            'zones' => [
                [
                    'id' => '5f1234567890abcdef123456',
                    'name' => 'Pool Deck',
                    'organisation_id' => '22222222-2222-2222-2222-222222222222',
                    'site_id' => '11111111-1111-1111-1111-111111111111'
                ]
            ],
            'user_id' => '5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d',
            'created_at' => '2025-02-04T12:00:00+01:00',
            'updated_at' => '2025-02-04T12:00:00+01:00'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"id": "5dcb47800000000000000000",
		"appointment_restrictions": []interface{}{
			map[string]interface{}{
				"id": "5dcb47800000000000000011",
				"applies_to_type": "specific",
				"appointment_type_ids": []interface{}{
					"5dcb47800000000000000010",
				},
				"appointment_types": []interface{}{
					map[string]interface{}{
						"id": "00000000-0000-0000-0000-000000000000",
						"name": "Alex Morgan",
					},
				},
				"categories": []interface{}{
					map[string]interface{}{
						"id": "00000000-0000-0000-0000-000000000000",
						"name": "Alex Morgan",
					},
				},
				"category_ids": []interface{}{
					"5dcb47800000000000000010",
				},
				"date_from": "2020-06-20",
				"date_to": "2020-06-20",
				"max_duration": 180,
				"occupied_mins": 60,
				"type": "cannot_offer",
			},
		},
		"avatar": map[string]interface{}{
			"id": "00000000-0000-0000-0000-000000000000",
			"file_name": "super-cool-photo.jpg",
			"mime_type": "image/jpeg",
			"original_url": "https://example.com/media/super-cool-photo.jpg",
			"size": 84256,
			"url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg",
		},
		"can_offer_tags": []interface{}{
			"string",
		},
		"gender": "female",
		"name": "Jane Doe",
		"organisation_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
		"site_ids": []interface{}{
			"00000000-0000-0000-0000-000000000000",
		},
		"tag_ids": []interface{}{
			"string",
		},
		"tags": []interface{}{
			map[string]interface{}{
				"id": "00000000-0000-0000-0000-000000000000",
				"name": "Alex Morgan",
				"organisation_id": "00000000-0000-0000-0000-000000000000",
			},
		},
		"zones": []interface{}{
			map[string]interface{}{
				"id": "5f1234567890abcdef123456",
				"name": "Pool Deck",
				"organisation_id": "22222222-2222-2222-2222-222222222222",
				"site_id": "11111111-1111-1111-1111-111111111111",
			},
		},
		"user_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
		"created_at": "2025-02-04T12:00:00+01:00",
		"updated_at": "2025-02-04T12:00:00+01:00",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/shop/practitioners", 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)
}

The practitioner was created.

{
  "data": {
    "id": "5dcb47800000000000000000",
    "appointment_restrictions": [
      {
        "id": "5dcb47800000000000000011",
        "applies_to_type": "specific",
        "appointment_type_ids": [
          "5dcb47800000000000000010"
        ],
        "appointment_types": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "Alex Morgan"
          }
        ],
        "categories": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "Alex Morgan"
          }
        ],
        "category_ids": [
          "5dcb47800000000000000010"
        ],
        "date_from": "2020-06-20",
        "date_to": "2020-06-20",
        "max_duration": 180,
        "occupied_mins": 60,
        "type": "cannot_offer"
      }
    ],
    "avatar": {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "can_offer_tags": [
      "string"
    ],
    "gender": "female",
    "name": "Jane Doe",
    "organisation_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
    "site_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "tag_ids": [
      "string"
    ],
    "tags": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Alex Morgan",
        "organisation_id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "zones": [
      {
        "id": "5f1234567890abcdef123456",
        "name": "Pool Deck",
        "organisation_id": "22222222-2222-2222-2222-222222222222",
        "site_id": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "user_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
    "created_at": "2025-02-04T12:00:00+01:00",
    "updated_at": "2025-02-04T12:00:00+01:00"
  }
}

{
  "message": "Unauthenticated"
}

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

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

Shop

Retrieve an Offering

Path parameters

Responses

List storefront appointment tags

Query parameters

Responses

List storefront appointment types

Query parameters

Responses

List storefront categories

Query parameters

Responses

List storefront offerings

Query parameters

Responses

List cross-sell offerings for an offering

Path parameters

Responses

List up-sell offerings for an offering

Path parameters

Responses

List storefront practitioners

Query parameters

Responses

Create a storefront practitioner

Request body

Responses