cURL
curl --location 'https://www.headout.com/api/public/v1/booking/' \
--header 'Headout-Auth: <YOUR_API_KEY>' \
--header 'Content-Type: application/json'
import requests
url = "https://www.headout.com/api/public/v1/booking/"
headers = {"Headout-Auth": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Headout-Auth': '<api-key>'}};
fetch('https://www.headout.com/api/public/v1/booking/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.headout.com/api/public/v1/booking/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Headout-Auth: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.headout.com/api/public/v1/booking/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Headout-Auth", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.headout.com/api/public/v1/booking/")
.header("Headout-Auth", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.headout.com/api/public/v1/booking/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Headout-Auth"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"bookingId": "126890",
"voucherId": "415872",
"partnerReferenceId": "AX67873DDFSR",
"variantId": "25525",
"status": "PENDING",
"startDateTime": "2025-04-12T19:30:00",
"product": {
"id": "18969",
"name": "Bali Swing Experience",
"variant": {
"id": "25525",
"name": "Standard Entry"
}
},
"customersDetails": {
"count": 1,
"customers": [
{
"personType": "ADULT",
"isPrimary": true,
"inputFields": [
{
"id": "NAME",
"name": "Name",
"value": "John Doe"
},
{
"id": "EMAIL",
"name": "Email",
"value": "john@example.com"
},
{
"id": "PHONE",
"name": "Phone",
"value": "+14155551234"
}
]
}
]
},
"seatInfo": null,
"variantInputFields": [],
"price": {
"amount": 77.08,
"currencyCode": "USD"
},
"creationTimestamp": 1712953295,
"voucherUrl": "https://www.headout.com/voucher/126890?key=AAAD6AAAABhsDVGl...",
"tickets": [
{
"publicId": "9e4d8330-abc7-40f8-951d-19b9e8731dcf",
"url": null,
"type": "QRCODE"
}
]
}
],
"nextUrl": "/api/public/v1/booking?offset=20&limit=20",
"prevUrl": null,
"total": 100,
"nextOffset": 20
}Bookings
List all bookings
We are soon moving to v2 APIs and v1 will be deprecated. Switch to v2 using the version selector above.
Retrieve a paginated list of all bookings associated with your partner account.
Visibility rule: FAILED bookings that never reached PENDING (i.e. partnerReferenceId is null) are excluded from results. All other bookings — including FAILED bookings that were previously captured — are included.
GET
/
api
/
public
/
v1
/
booking
/
cURL
curl --location 'https://www.headout.com/api/public/v1/booking/' \
--header 'Headout-Auth: <YOUR_API_KEY>' \
--header 'Content-Type: application/json'
import requests
url = "https://www.headout.com/api/public/v1/booking/"
headers = {"Headout-Auth": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Headout-Auth': '<api-key>'}};
fetch('https://www.headout.com/api/public/v1/booking/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.headout.com/api/public/v1/booking/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Headout-Auth: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.headout.com/api/public/v1/booking/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Headout-Auth", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.headout.com/api/public/v1/booking/")
.header("Headout-Auth", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.headout.com/api/public/v1/booking/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Headout-Auth"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"bookingId": "126890",
"voucherId": "415872",
"partnerReferenceId": "AX67873DDFSR",
"variantId": "25525",
"status": "PENDING",
"startDateTime": "2025-04-12T19:30:00",
"product": {
"id": "18969",
"name": "Bali Swing Experience",
"variant": {
"id": "25525",
"name": "Standard Entry"
}
},
"customersDetails": {
"count": 1,
"customers": [
{
"personType": "ADULT",
"isPrimary": true,
"inputFields": [
{
"id": "NAME",
"name": "Name",
"value": "John Doe"
},
{
"id": "EMAIL",
"name": "Email",
"value": "john@example.com"
},
{
"id": "PHONE",
"name": "Phone",
"value": "+14155551234"
}
]
}
]
},
"seatInfo": null,
"variantInputFields": [],
"price": {
"amount": 77.08,
"currencyCode": "USD"
},
"creationTimestamp": 1712953295,
"voucherUrl": "https://www.headout.com/voucher/126890?key=AAAD6AAAABhsDVGl...",
"tickets": [
{
"publicId": "9e4d8330-abc7-40f8-951d-19b9e8731dcf",
"url": null,
"type": "QRCODE"
}
]
}
],
"nextUrl": "/api/public/v1/booking?offset=20&limit=20",
"prevUrl": null,
"total": 100,
"nextOffset": 20
}Authorizations
Response
200 - application/json
Successful response
The bookings in this page of results.
Show child attributes
Show child attributes
Full URL to fetch the next page of results. Null if on the last page.
Full URL to fetch the previous page of results. Null if on the first page.
Total number of bookings matching the query across all pages.
Offset value to use in the next request to retrieve the following page.
Was this page helpful?