Lavanda Developer API
API change historyLavanda Developer API
Request
Request URL
Request parameters
-
(optional)string
Return bookings belonging to a property.
-
(optional)string
Format - YYYY-MM-DDTHH:MM:SS. Format - YYYY-MM-DDTHH:MM:SS. Format - YYYY-MM-DDTHH:MM:SS. Format - YYYY-MM-DDTHH:MM:SS. Format - YYYY-MM-DDTHH:MM:SS. Return all bookings that were last modified after this date-time
-
(optional)integer
Number of bookings returned per page. Maximum and default value of 50 bookings
-
(optional)string
Cursor-based pagination that identifies the last record of the previous page - Can be retrieved at 'meta[page][next]' and it's not the same value as the record ID
Request headers
Request body
Responses
200 OK
Success
Representations
{
"data": [
{
"id": "fx8HtMt_X2V-bOiypn1dLf014m4moFXoltNuGOVn39o",
"type": "booking",
"attributes": {
"booked_time": "2020-12-31T12:30:00Z",
"canceled": false,
"confirmation_code": "2J999F",
"currency": "GBP",
"end_date": "2023-06-17",
"last_modified": "2021-11-18T15:25:07Z",
"lead_guest_first_name": "Lewis",
"lead_guest_last_name": "Leo",
"lead_guest_email": "sneaky@pete.com",
"lead_guest_phone_number": "01234567987",
"messaging_mode": "direct_to_guest",
"number_of_guests": 4,
"platform": "Airbnb",
"source": "Google",
"start_date": "2023-05-18",
"status": "requested",
"total_days": 30,
"total_cost": 606
},
"relationships": {
"property": {
"data": {
"id": "BbPvUzHRncDFnraB-mYQWcWVITypprOsljtqyQrHXYE",
"type": "property"
}
},
"unit": {
"data": {
"id": "BbPvUzHRncDFnraB-mYQWcWVITypprOsljtqyQrHXYE",
"type": "property"
}
}
}
}
],
"meta": {
"page": {
"total": 2,
"number": 1,
"next": "eyJwYWdlX251bWJlciI6MiwidmFsdWVzIjp7ImlkIjoxfX0="
},
"records": {
"number": 1,
"total": 2
}
}
}{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
},
"booked_time": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"total_days": {
"type": "number"
},
"total_cost": {
"type": "number"
},
"currency": {
"type": "string"
},
"canceled": {
"type": "boolean"
},
"confirmation_code": {
"type": "string",
"x-nullable": true
},
"booking": {
"type": "string"
},
"platform": {
"type": "string"
},
"lead_guest_first_name": {
"type": "string"
},
"lead_guest_last_name": {
"type": "string"
},
"lead_guest_email": {
"type": "string"
},
"lead_guest_phone_number": {
"type": "string",
"x-nullable": true
},
"messaging_mode": {
"type": "string",
"enum": [
"direct_to_guest",
"relay_via_webhook"
]
},
"number_of_guests": {
"type": "number"
},
"source": {
"type": "string",
"x-nullable": true
},
"status": {
"type": "string",
"enum": [
"awaiting_payment",
"canceled",
"closed",
"confirmed",
"declined",
"expired",
"inquiry",
"requested",
"reserved"
]
},
"last_modified": {
"type": "string",
"format": "date-time"
}
}
},
"relationships": {
"type": "object",
"properties": {
"property": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
},
"unit": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"page": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"number": {
"type": "number"
},
"next": {
"type": "string",
"x-nullable": true
}
}
},
"records": {
"type": "object",
"properties": {
"number": {
"type": "number"
},
"total": {
"type": "number"
}
}
}
}
},
"included": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object"
}
}
}
}
}
}401 Unauthorized
Unauthorized
Representations
403 Forbidden
Forbidden
Representations
500 Internal Server Error
Server error
Representations
Code samples
@ECHO OFF
curl -v -X GET "https://lavanda.azure-api.net/bookings?property_id={string}&last_modified={string}&page[size]={integer}&page[after]={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["property_id"] = "{string}";
queryString["last_modified"] = "{string}";
queryString["page[size]"] = "{integer}";
queryString["page[after]"] = "{string}";
var uri = "https://lavanda.azure-api.net/bookings?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://lavanda.azure-api.net/bookings");
builder.setParameter("property_id", "{string}");
builder.setParameter("last_modified", "{string}");
builder.setParameter("page[size]", "{integer}");
builder.setParameter("page[after]", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"property_id": "{string}",
"last_modified": "{string}",
"page[size]": "{integer}",
"page[after]": "{string}",
};
$.ajax({
url: "https://lavanda.azure-api.net/bookings?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://lavanda.azure-api.net/bookings";
NSArray* array = @[
// Request parameters
@"entities=true",
@"property_id={string}",
@"last_modified={string}",
@"page[size]={integer}",
@"page[after]={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://lavanda.azure-api.net/bookings');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'property_id' => '{string}',
'last_modified' => '{string}',
'page[size]' => '{integer}',
'page[after]' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'property_id': '{string}',
'last_modified': '{string}',
'page[size]': '{integer}',
'page[after]': '{string}',
})
try:
conn = httplib.HTTPSConnection('lavanda.azure-api.net')
conn.request("GET", "/bookings?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'property_id': '{string}',
'last_modified': '{string}',
'page[size]': '{integer}',
'page[after]': '{string}',
})
try:
conn = http.client.HTTPSConnection('lavanda.azure-api.net')
conn.request("GET", "/bookings?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://lavanda.azure-api.net/bookings')
query = URI.encode_www_form({
# Request parameters
'property_id' => '{string}',
'last_modified' => '{string}',
'page[size]' => '{integer}',
'page[after]' => '{string}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body