Booking Flow

Appointment Enquiries

Manage appointment enquiries.

post/shop/appointment-enquiries/{appointmentEnquiryId}/confirm

Confirm an enquiry using the start time provided.

actionConfirmAppointmentEnquiry

Use this endpoint to confirm an appointment enquiry

Path parameters

appointmentEnquiryIdmongo-idoptional
The ID of the appointment enquiry.

Request body

timestringrequired
The date and time that the appointment should start.

Responses

200
Results of the availability check for an appointment enquiry
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/appointment-enquiries/abc123/confirm" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "time": "2026-06-15T10:00:00Z"
}'

const response = await fetch('https://api.playground.try.be/shop/appointment-enquiries/abc123/confirm', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "time": "2026-06-15T10:00:00Z"
  }),
})

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/appointment-enquiries/abc123/confirm",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "time": "2026-06-15T10:00:00Z"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/appointment-enquiries/abc123/confirm', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'time' => '2026-06-15T10:00:00Z'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"time": "2026-06-15T10:00:00Z",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/appointment-enquiries/abc123/confirm", 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)
}

Results of the availability check for an appointment enquiry

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "appointment_type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "appointment_type_name": "string",
    "time_from": "2026-01-15T09:30:00+00:00",
    "time_to": "2026-01-15T09:30:00+00:00",
    "status": "received",
    "can_confirm": false,
    "cancellation_reason": "expired",
    "order": {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "order_ref": "TRY00",
      "full_name": "Jessica Jones"
    },
    "last_checked_at": "2026-01-15T09:30:00+00:00",
    "received_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

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

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

get/shop/reports/appointment-enquiries

List appointment enquiries

listAppointmentEnquiries

Use this endpoint to retrieve a list of AppointmentEnquiry resources associated with a Site.

Query parameters

site_iduuidoptional
Filter the list of enquiries by site
pageintegeroptional
The page to retrieve results from
date_fromdateoptional
Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.
date_todateoptional
Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.
statusstringoptional
Show enquiries of this status.
Possible values:receivedconfirmedcancelled
can_confirmbooleanoptional
Filter the list of enquiries by whether they are currently able to be confirmed.
received_fromdateoptional
Include enquiries where the date the enquiry was received is on or after this date.
received_todateoptional
Include enquiries where the date the enquiry was received is on or before this date.
appointment_type_idobject-idoptional
Show enquiries for this appointment type.
sortstringoptional
The field to order results by.
sort_orderstringoptional
The direction to order results by.
Possible values:ascdesc

Responses

200
The list of AppointmentEnquiry resources was successfully retrieved.
401
The user is unauthenticated

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

const response = await fetch('https://api.playground.try.be/shop/reports/appointment-enquiries', {
  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/reports/appointment-enquiries",
    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/reports/appointment-enquiries', [
    '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/reports/appointment-enquiries", 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)
}

The list of `AppointmentEnquiry` resources was successfully retrieved.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "appointment_type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "appointment_type_name": "string",
      "time_from": "2026-01-15T09:30:00+00:00",
      "time_to": "2026-01-15T09:30:00+00:00",
      "status": "received",
      "can_confirm": false,
      "cancellation_reason": "expired",
      "order": {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "order_ref": "TRY00",
        "full_name": "Jessica Jones"
      },
      "last_checked_at": "2026-01-15T09:30:00+00:00",
      "received_at": "2026-01-15T09:30:00+00:00"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "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"
  }
}

{
  "message": "Unauthenticated"
}

get/shop/reports/appointment-enquiries/queue

Queue an export of the appointment enquiries list

actionQueueAppointmentEnquirieReport

This endpoint queues an export of the appointment enquiries list.

Query parameters

site_iduuidoptional
Filter the list of enquiries by site
date_fromdateoptional
Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.
date_todateoptional
Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.
statusstringoptional
Show enquiries of this status.
Possible values:receivedconfirmedcancelled
can_confirmbooleanoptional
Filter the list of enquiries by whether they are currently able to be confirmed.
received_fromdateoptional
Include enquiries where the date the enquiry was received is on or after this date.
received_todateoptional
Include enquiries where the date the enquiry was received is on or before this date.
appointment_type_idobject-idoptional
Show enquiries for this appointment type.

Responses

200
The job was successfully queued
400
The request failed.
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/appointment-enquiries/queue" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/appointment-enquiries/queue', {
  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/reports/appointment-enquiries/queue",
    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/reports/appointment-enquiries/queue', [
    '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/reports/appointment-enquiries/queue", 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)
}

The job was successfully queued

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "output": {},
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

get/shop/reports/appointment-enquiries/smart-filters

Get a list of smart filters for the appointment enquiries list.

getAppointmentEnquiriesSmartFilters

This endpoint retrieves a list of smart filters for the appointment enquiries list.

Query parameters

site_iduuidoptional
Filter the list of enquiries by site

Responses

200
The smart filters were retrieved
400
The request failed.
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/appointment-enquiries/smart-filters" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/appointment-enquiries/smart-filters', {
  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/reports/appointment-enquiries/smart-filters",
    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/reports/appointment-enquiries/smart-filters', [
    '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/reports/appointment-enquiries/smart-filters", 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)
}

The smart filters were retrieved

{
  "data": [
    {
      "key": "recently_created",
      "name": "Recently created",
      "count": 12,
      "filters": [
        {
          "key": "date_from",
          "type": "string",
          "string_value": "confirmed",
          "date_value": "2026-01-15T09:30:00+00:00",
          "boolean_value": false
        }
      ]
    }
  ]
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

get/shop/appointment-enquiries/{appointmentEnquiryId}

Use this endpoint to retrieve a single AppointmentEnquiry by its ID. The response includes the enquiry's current status (received, confirmed or cancelled), the time window the enquiry covers (time_from and time_to), and a can_confirm flag indicating whether the requested appointment can currently be booked.

This is typically used after listing enquiries via listAppointmentEnquiries to refresh availability before calling actionConfirmAppointmentEnquiry.

Path parameters

appointmentEnquiryIdmongo-idrequired
The ID of the AppointmentEnquiry to retrieve.

Responses

200
The AppointmentEnquiry was successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/shop/appointment-enquiries/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/appointment-enquiries/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/appointment-enquiries/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/appointment-enquiries/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)
}

The `AppointmentEnquiry` was successfully retrieved.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "appointment_type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "appointment_type_name": "string",
    "time_from": "2026-01-15T09:30:00+00:00",
    "time_to": "2026-01-15T09:30:00+00:00",
    "status": "received",
    "can_confirm": false,
    "cancellation_reason": "expired",
    "order": {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "order_ref": "TRY00",
      "full_name": "Jessica Jones"
    },
    "last_checked_at": "2026-01-15T09:30:00+00:00",
    "received_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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