Browse bookings
curl --request POST \
--url https://{apiBaseUrl}/api/bookings-manager/entities/{entity_id}/bookings/browse \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"limit": 123,
"offset": 123,
"query": {
"criteria": [
{
"criteria": [
{
"value": "<string>"
}
]
}
]
}
}
'const url = 'https://{apiBaseUrl}/api/bookings-manager/entities/{entity_id}/bookings/browse';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
limit: 123,
offset: 123,
query: {criteria: [{criteria: [{value: '<string>'}]}]}
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://{apiBaseUrl}/api/bookings-manager/entities/{entity_id}/bookings/browse"
payload = {
"limit": 123,
"offset": 123,
"query": { "criteria": [{ "criteria": [{ "value": "<string>" }] }] }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{apiBaseUrl}/api/bookings-manager/entities/{entity_id}/bookings/browse",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'limit' => 123,
'offset' => 123,
'query' => [
'criteria' => [
[
'criteria' => [
[
'value' => '<string>'
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}using RestSharp;
var options = new RestClientOptions("https://{apiBaseUrl}/api/bookings-manager/entities/{entity_id}/bookings/browse");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"limit\": 123,\n \"offset\": 123,\n \"query\": {\n \"criteria\": [\n {\n \"criteria\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.post("https://{apiBaseUrl}/api/bookings-manager/entities/{entity_id}/bookings/browse")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"limit\": 123,\n \"offset\": 123,\n \"query\": {\n \"criteria\": [\n {\n \"criteria\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n }\n}")
.asString();{
"bookings": [
{
"guest": {
"country": "<string>",
"firstname": "<string>",
"birthdate": "<string>",
"gender": "<string>",
"languages": "<string>",
"city": "<string>",
"timezone": "<string>",
"emailDomains": "<string>",
"phones": "<string>",
"entityId": "<string>",
"nationalities": "<string>",
"tags": "<string>",
"lastname": "<string>",
"emails": "<string>",
"createdAt": "<string>",
"street": "<string>",
"anonymous": true,
"id": "<string>",
"updatedAt": "<string>"
},
"booking": {
"fare": 123,
"touristTax": 123,
"arrival": "<string>",
"arrivalDay": "<string>",
"bookingDateArrival": "<string>",
"weekend": true,
"channel": "<string>",
"stayLength": 123,
"paxAdults": 123,
"balance": 123,
"farePerNight": 123,
"instayDows": [
"<string>"
],
"departureDow": "<string>",
"guestId": "<string>",
"roomType": "<string>",
"updatedAt": "<string>",
"filledCustomFields": [
"<string>"
],
"instayDates": [
"<string>"
],
"paxBabies": 123,
"entityId": "<string>",
"departureDay": "<string>",
"room": "<string>",
"tags": [
"<string>"
],
"arrivalDow": "<string>",
"closed": true,
"bookingDate": "<string>",
"departure": "<string>",
"paxChildren": 123,
"status": "<string>"
}
}
],
"total": 123
}Search
Browse bookings
Page through the bookings of an entity with their guest
POST
/
api
/
bookings-manager
/
entities
/
{entity_id}
/
bookings
/
browse
Browse bookings
curl --request POST \
--url https://{apiBaseUrl}/api/bookings-manager/entities/{entity_id}/bookings/browse \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"limit": 123,
"offset": 123,
"query": {
"criteria": [
{
"criteria": [
{
"value": "<string>"
}
]
}
]
}
}
'const url = 'https://{apiBaseUrl}/api/bookings-manager/entities/{entity_id}/bookings/browse';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
limit: 123,
offset: 123,
query: {criteria: [{criteria: [{value: '<string>'}]}]}
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://{apiBaseUrl}/api/bookings-manager/entities/{entity_id}/bookings/browse"
payload = {
"limit": 123,
"offset": 123,
"query": { "criteria": [{ "criteria": [{ "value": "<string>" }] }] }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{apiBaseUrl}/api/bookings-manager/entities/{entity_id}/bookings/browse",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'limit' => 123,
'offset' => 123,
'query' => [
'criteria' => [
[
'criteria' => [
[
'value' => '<string>'
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}using RestSharp;
var options = new RestClientOptions("https://{apiBaseUrl}/api/bookings-manager/entities/{entity_id}/bookings/browse");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"limit\": 123,\n \"offset\": 123,\n \"query\": {\n \"criteria\": [\n {\n \"criteria\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.post("https://{apiBaseUrl}/api/bookings-manager/entities/{entity_id}/bookings/browse")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"limit\": 123,\n \"offset\": 123,\n \"query\": {\n \"criteria\": [\n {\n \"criteria\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n }\n}")
.asString();{
"bookings": [
{
"guest": {
"country": "<string>",
"firstname": "<string>",
"birthdate": "<string>",
"gender": "<string>",
"languages": "<string>",
"city": "<string>",
"timezone": "<string>",
"emailDomains": "<string>",
"phones": "<string>",
"entityId": "<string>",
"nationalities": "<string>",
"tags": "<string>",
"lastname": "<string>",
"emails": "<string>",
"createdAt": "<string>",
"street": "<string>",
"anonymous": true,
"id": "<string>",
"updatedAt": "<string>"
},
"booking": {
"fare": 123,
"touristTax": 123,
"arrival": "<string>",
"arrivalDay": "<string>",
"bookingDateArrival": "<string>",
"weekend": true,
"channel": "<string>",
"stayLength": 123,
"paxAdults": 123,
"balance": 123,
"farePerNight": 123,
"instayDows": [
"<string>"
],
"departureDow": "<string>",
"guestId": "<string>",
"roomType": "<string>",
"updatedAt": "<string>",
"filledCustomFields": [
"<string>"
],
"instayDates": [
"<string>"
],
"paxBabies": 123,
"entityId": "<string>",
"departureDay": "<string>",
"room": "<string>",
"tags": [
"<string>"
],
"arrivalDow": "<string>",
"closed": true,
"bookingDate": "<string>",
"departure": "<string>",
"paxChildren": 123,
"status": "<string>"
}
}
],
"total": 123
}This endpoint sits on the bookings service, so its path starts with
/api/bookings-manager/ where the rest of the API starts with /api/guestprofile/. Everything else is unchanged: same token, same entity identifier, same query model. The fields a criterion can target, and the operators each one accepts, are listed on the Search criteria page.
Each item pairs the booking with the guest it belongs to. Paginate with limit and offset against the total the response carries, where Browse guests uses an afterKey cursor.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Was this page helpful?