Get Booking
curl --request GET \
--url https://ipos.dev.nowbookit.com/Bookings/{id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://ipos.dev.nowbookit.com/Bookings/{id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://ipos.dev.nowbookit.com/Bookings/{id}', 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://ipos.dev.nowbookit.com/Bookings/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <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://ipos.dev.nowbookit.com/Bookings/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<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://ipos.dev.nowbookit.com/Bookings/{id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ipos.dev.nowbookit.com/Bookings/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"locationId": "<string>",
"bookingId": "<string>",
"method": "<string>",
"bookedAt": "<string>",
"bookingTime": "<string>",
"duration": 123,
"people": 123,
"customer": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"company": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"phoneNational": "<string>",
"phone2": "<string>",
"birthdayDate": 123,
"birthdayMonth": 123,
"birthdayYear": 123,
"notes": "<string>",
"noShowCount": 123,
"tags": [
{
"id": "<string>",
"identifier": "<string>",
"name": "<string>"
}
],
"subscribed": true,
"lastModifiedDate": "<string>"
},
"tables": [
{
"tableId": "<string>",
"tableName": "<string>",
"sectionId": "<string>",
"sectionName": "<string>"
}
],
"tags": [
{
"tagType": "<string>",
"name": "<string>"
}
],
"status": {
"statusType": "<string>",
"code": "<string>",
"name": "<string>"
},
"notes": "<string>",
"paymentSummary": {
"paymentType": "<string>",
"amount": 123,
"amountDue": 123,
"transactionId": "<string>",
"currencyCode": "<string>",
"amountPaid": 123,
"paymentDate": "<string>"
},
"serviceId": "<string>",
"lastModifiedDate": "<string>",
"serviceName": "<string>",
"serviceType": "<string>",
"items": [
{
"name": "<string>",
"label": "<string>",
"price": 123,
"quantity": 123,
"paymentType": "<string>",
"extras": [
{
"name": "<string>",
"label": "<string>",
"price": 123,
"quantity": 123,
"paymentType": "<string>"
}
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Bookings
Get Booking
Retrieve a single booking by its unique NowBookIt booking ID
GET
/
Bookings
/
{id}
Get Booking
curl --request GET \
--url https://ipos.dev.nowbookit.com/Bookings/{id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://ipos.dev.nowbookit.com/Bookings/{id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://ipos.dev.nowbookit.com/Bookings/{id}', 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://ipos.dev.nowbookit.com/Bookings/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <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://ipos.dev.nowbookit.com/Bookings/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<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://ipos.dev.nowbookit.com/Bookings/{id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ipos.dev.nowbookit.com/Bookings/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"locationId": "<string>",
"bookingId": "<string>",
"method": "<string>",
"bookedAt": "<string>",
"bookingTime": "<string>",
"duration": 123,
"people": 123,
"customer": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"company": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"phoneNational": "<string>",
"phone2": "<string>",
"birthdayDate": 123,
"birthdayMonth": 123,
"birthdayYear": 123,
"notes": "<string>",
"noShowCount": 123,
"tags": [
{
"id": "<string>",
"identifier": "<string>",
"name": "<string>"
}
],
"subscribed": true,
"lastModifiedDate": "<string>"
},
"tables": [
{
"tableId": "<string>",
"tableName": "<string>",
"sectionId": "<string>",
"sectionName": "<string>"
}
],
"tags": [
{
"tagType": "<string>",
"name": "<string>"
}
],
"status": {
"statusType": "<string>",
"code": "<string>",
"name": "<string>"
},
"notes": "<string>",
"paymentSummary": {
"paymentType": "<string>",
"amount": 123,
"amountDue": 123,
"transactionId": "<string>",
"currencyCode": "<string>",
"amountPaid": 123,
"paymentDate": "<string>"
},
"serviceId": "<string>",
"lastModifiedDate": "<string>",
"serviceName": "<string>",
"serviceType": "<string>",
"items": [
{
"name": "<string>",
"label": "<string>",
"price": 123,
"quantity": 123,
"paymentType": "<string>",
"extras": [
{
"name": "<string>",
"label": "<string>",
"price": 123,
"quantity": 123,
"paymentType": "<string>"
}
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}string
required
Your partner API key.
Path Parameters
string
required
The NowBookIt booking ID. Obtained from List Bookings or Create Booking.
Response
string
Unique NowBookIt booking identifier.
string
NowBookIt venue/location identifier.
string
How the booking was created (e.g.,
"online", "phone", "walkin", "pos").string
ISO 8601 timestamp of when the booking was originally created.
string
Booking datetime in venue local time.
integer
Duration in minutes.
integer
Number of guests.
string
NowBookIt service ID.
string
Human-readable service name.
string
Service type classification.
string
ISO 8601 timestamp of the most recent modification.
string
Booking notes.
object
Customer/guest details
array
object
object
Payment details for the booking.
array
Examples
curl https://{base_url}/Bookings/bk_abc123 \
-H "X-API-KEY: your_api_key"
const bookingId = "bk_abc123";
const response = await fetch(`https://{base_url}/Bookings/${bookingId}`, {
headers: { "X-API-KEY": "your_api_key" },
});
if (response.status === 404) {
console.error("Booking not found");
} else {
const booking = await response.json();
console.log(booking);
}
import requests
booking_id = "bk_abc123"
response = requests.get(
f"https://{{base_url}}/Bookings/{booking_id}",
headers={"X-API-KEY": "your_api_key"}
)
if response.status_code == 404:
print("Booking not found")
else:
print(response.json())
Example Response (200)
{
"bookingId": "bk_abc123",
"locationId": "loc_xyz789",
"method": "online",
"bookedAt": "2024-05-28T09:14:22Z",
"bookingTime": "2024-06-15T19:00:00",
"duration": 90,
"people": 4,
"serviceId": "svc_dinner",
"serviceName": "Dinner",
"serviceType": "standard",
"lastModifiedDate": "2024-06-01T10:30:00Z",
"notes": "Birthday celebration — window table preferred",
"customer": {
"id": "cust_111",
"firstName": "Jane",
"lastName": "Smith",
"company": null,
"email": "[email protected]",
"phone": "+61412345678",
"phoneNational": "0412 345 678",
"phone2": null,
"address": null,
"birthdayDate": null
},
"tables": [
{
"tableId": "tbl_001",
"tableName": "Table 5",
"sectionId": "sec_main",
"sectionName": "Main Floor"
}
],
"tags": [
{ "tagType": "occasion", "name": "Birthday" }
],
"status": {
"statusType": "confirmed",
"code": "CNF",
"name": "Confirmed"
},
"paymentSummary": {
"paymentType": "card",
"amount": 40.00,
"amountDue": 0.00,
"amountPaid": 40.00,
"transactionId": "txn_9876",
"currencyCode": "AUD",
"paymentDate": "2024-05-28T09:14:50Z"
},
"items": []
}
Status Codes
| Code | Description |
|---|---|
200 | Success |
400 | Invalid request |
401 | Invalid or missing X-API-KEY |
404 | Booking not found |
429 | Rate limit exceeded |
Authorizations
Headers
API Key authentication header
Path Parameters
Response
Get Booking By Id
The Pos System Location Id for the Venue.
The Unique booking id.
The method used for booking.
The UTC Date & Time when the booking was made.
The booking time.
Duration of Booking in minutes.
Total number of people in booking.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes