{ "item": [ { "name": "developer", "description": "", "item": [ { "name": "search", "description": "", "item": [ { "id": "ecf6158b-4590-4e9b-aa83-5dc4e805c5ee", "name": "Search properties with filters", "request": { "name": "Search properties with filters", "description": { "content": "Search holiday rental properties by location, dates, guest count, and amenities. Returns paginated results with property summaries including title, price, images, and availability. Use this as the starting point for any property discovery flow.\n", "type": "text/plain" }, "url": { "path": [ "developer", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Place slug or name (e.g., \"exmoor\", \"north-devon\")", "type": "text/plain" }, "key": "place", "value": "" }, { "disabled": false, "description": { "content": "Check-in date (YYYY-MM-DD)", "type": "text/plain" }, "key": "checkin", "value": "" }, { "disabled": false, "description": { "content": "Number of nights", "type": "text/plain" }, "key": "nights", "value": "" }, { "disabled": false, "description": { "content": "Number of guests", "type": "text/plain" }, "key": "guests", "value": "" }, { "disabled": false, "description": { "content": "Minimum number of bedrooms", "type": "text/plain" }, "key": "bedrooms", "value": "" }, { "disabled": false, "description": { "content": "\"yes\" to filter pet-friendly properties only (This can only be one of yes)", "type": "text/plain" }, "key": "pets", "value": "yes" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Results per page (default: 20, max: 100)", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Sort field: \"price\", \"rating\", or \"title\" (This can only be one of price,rating,title)", "type": "text/plain" }, "key": "sort", "value": "price" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "db1ca9ff-ba81-4267-bc5d-3874a7c3d7b1", "name": "Paginated list of properties matching the search criteria", "originalRequest": { "url": { "path": [ "developer", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Place slug or name (e.g., \"exmoor\", \"north-devon\")", "type": "text/plain" }, "key": "place", "value": "" }, { "disabled": false, "description": { "content": "Check-in date (YYYY-MM-DD)", "type": "text/plain" }, "key": "checkin", "value": "" }, { "disabled": false, "description": { "content": "Number of nights", "type": "text/plain" }, "key": "nights", "value": "" }, { "disabled": false, "description": { "content": "Number of guests", "type": "text/plain" }, "key": "guests", "value": "" }, { "disabled": false, "description": { "content": "Minimum number of bedrooms", "type": "text/plain" }, "key": "bedrooms", "value": "" }, { "disabled": false, "description": { "content": "\"yes\" to filter pet-friendly properties only (This can only be one of yes)", "type": "text/plain" }, "key": "pets", "value": "yes" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Results per page (default: 20, max: 100)", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Sort field: \"price\", \"rating\", or \"title\" (This can only be one of price,rating,title)", "type": "text/plain" }, "key": "sort", "value": "price" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"properties\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"slug\": \"\",\n \"is_pets\": \"\",\n \"status\": \"active\",\n \"property_place_slug\": \"\",\n \"bed_rooms\": \"\",\n \"total_guest\": \"\",\n \"bath_rooms\": \"\",\n \"min_price\": \"\",\n \"price_per_night\": \"\",\n \"price_per_week\": \"\",\n \"apply_price\": \"weekly\",\n \"thumbnailUrl\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"search_summary\": \"\",\n \"rating\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"slug\": \"\",\n \"is_pets\": \"\",\n \"status\": \"inactive\",\n \"property_place_slug\": \"\",\n \"bed_rooms\": \"\",\n \"total_guest\": \"\",\n \"bath_rooms\": \"\",\n \"min_price\": \"\",\n \"price_per_night\": \"\",\n \"price_per_week\": \"\",\n \"apply_price\": \"monthly\",\n \"thumbnailUrl\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"search_summary\": \"\",\n \"rating\": \"\"\n }\n ],\n \"total_property_on_search\": \"\",\n \"current_page\": \"\",\n \"num_pages\": \"\",\n \"perpage\": \"\",\n \"filter_array_values\": {},\n \"search_query_string\": \"\",\n \"property_checkin\": \"\",\n \"property_booking_nights\": \"\",\n \"property_guests\": \"\",\n \"propertyRating\": {},\n \"marker_array\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ae41150-8be0-441b-8ca9-ff5164d41d28", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Place slug or name (e.g., \"exmoor\", \"north-devon\")", "type": "text/plain" }, "key": "place", "value": "" }, { "disabled": false, "description": { "content": "Check-in date (YYYY-MM-DD)", "type": "text/plain" }, "key": "checkin", "value": "" }, { "disabled": false, "description": { "content": "Number of nights", "type": "text/plain" }, "key": "nights", "value": "" }, { "disabled": false, "description": { "content": "Number of guests", "type": "text/plain" }, "key": "guests", "value": "" }, { "disabled": false, "description": { "content": "Minimum number of bedrooms", "type": "text/plain" }, "key": "bedrooms", "value": "" }, { "disabled": false, "description": { "content": "\"yes\" to filter pet-friendly properties only (This can only be one of yes)", "type": "text/plain" }, "key": "pets", "value": "yes" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Results per page (default: 20, max: 100)", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Sort field: \"price\", \"rating\", or \"title\" (This can only be one of price,rating,title)", "type": "text/plain" }, "key": "sort", "value": "price" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7690052e-a8dd-4968-8a65-e4f11489bf67", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Place slug or name (e.g., \"exmoor\", \"north-devon\")", "type": "text/plain" }, "key": "place", "value": "" }, { "disabled": false, "description": { "content": "Check-in date (YYYY-MM-DD)", "type": "text/plain" }, "key": "checkin", "value": "" }, { "disabled": false, "description": { "content": "Number of nights", "type": "text/plain" }, "key": "nights", "value": "" }, { "disabled": false, "description": { "content": "Number of guests", "type": "text/plain" }, "key": "guests", "value": "" }, { "disabled": false, "description": { "content": "Minimum number of bedrooms", "type": "text/plain" }, "key": "bedrooms", "value": "" }, { "disabled": false, "description": { "content": "\"yes\" to filter pet-friendly properties only (This can only be one of yes)", "type": "text/plain" }, "key": "pets", "value": "yes" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Results per page (default: 20, max: 100)", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Sort field: \"price\", \"rating\", or \"title\" (This can only be one of price,rating,title)", "type": "text/plain" }, "key": "sort", "value": "price" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "properties", "description": "", "item": [ { "name": "specialoffers", "description": "", "item": [ { "id": "1862b4fa-5655-41c6-b22f-abb8dd6a6309", "name": "Get special offers across all properties", "request": { "name": "Get special offers across all properties", "description": { "content": "Retrieve current special offers and promotional prices across all properties. Returns discounted stays with check-in/check-out dates and offer prices. Use this to highlight deals on a homepage or promotions page.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", "specialoffers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2c42ba6f-025d-4188-87bc-28ac8da94c37", "name": "List of special offers across all properties", "originalRequest": { "url": { "path": [ "developer", "properties", "specialoffers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"propertyId\": \"\",\n \"price\": \"\",\n \"checkin\": \"\",\n \"checkout\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"propertyId\": \"\",\n \"price\": \"\",\n \"checkin\": \"\",\n \"checkout\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0c9cccd-07d0-4bbf-8be4-00ffa7c233c8", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", "specialoffers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95cd28dd-0e3f-4c1b-a3f3-d79993112e8b", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", "specialoffers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{id}", "description": "", "item": [ { "id": "75c6b6e3-2255-4468-a6a2-8a7359b1bda5", "name": "Get property details by ID", "request": { "name": "Get property details by ID", "description": { "content": "Get full details for a specific property including title, description, location, amenities, pricing information, and images. Use this after finding a property via search to display its full listing page.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "62c7d1ba-9bf7-4d73-a206-10af2852f329", "name": "Full property details including description, amenities, pricing, and location", "originalRequest": { "url": { "path": [ "developer", "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"title\": \"\",\n \"slug\": \"\",\n \"is_pets\": \"\",\n \"status\": \"active\",\n \"live\": \"no\",\n \"online\": \"no\",\n \"modified\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"description\": \"\",\n \"things_to_do\": \"\",\n \"food_and_drinks\": \"\",\n \"walk_and_beaches\": \"\",\n \"search_summary\": \"\",\n \"bed_rooms\": \"\",\n \"total_guest\": \"\",\n \"additional_guest\": \"\",\n \"free_guest\": \"\",\n \"single_beds\": \"\",\n \"double_beds\": \"\",\n \"king_beds\": \"\",\n \"sofa_beds\": \"\",\n \"cots\": \"\",\n \"bath_rooms\": \"\",\n \"family_bathrooms\": \"\",\n \"en_suites\": \"\",\n \"shower_rooms\": \"\",\n \"price_per_night\": \"\",\n \"price_per_week\": \"\",\n \"min_price\": \"\",\n \"apply_price\": \"fixed\",\n \"additional_guest_price\": \"\",\n \"security_deposit\": \"\",\n \"security_deposit_info\": \"\",\n \"amenities_set\": \"\",\n \"holiday_types_set\": \"\",\n \"indoors_set\": \"\",\n \"indoor_description\": \"\",\n \"outdoors_set\": \"\",\n \"outdoor_description\": \"\",\n \"parking\": \"\",\n \"max_vehicle_allowed\": \"\",\n \"ev_charge_note\": \"\",\n \"wifi_download_speed\": \"\",\n \"wifi_upload_speed\": \"\",\n \"checkin\": \"\",\n \"checkout\": \"\",\n \"house_rules\": \"\",\n \"suitable_type_set\": \"\",\n \"children_suitable\": \"\",\n \"pets_suitable\": \"\",\n \"cat_note\": \"\",\n \"mobility_suitable\": \"\",\n \"restricted_mobility_note\": \"\",\n \"property_place_id\": \"\",\n \"property_place_slug\": \"\",\n \"region\": \"\",\n \"area\": \"\",\n \"airport_name\": \"\",\n \"airport_distance\": \"\",\n \"trainStation_name\": \"\",\n \"trainStation_distance\": \"\",\n \"nearestbeach_name\": \"\",\n \"nearestbeach_distance\": \"\",\n \"nearestshop_distance\": \"\",\n \"tip_get_there\": \"\",\n \"youtube_url\": \"\",\n \"virtualTour_url\": \"\",\n \"created\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4efe7fb1-4759-4f85-8cbb-7cfcf4441c97", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e60d8524-997e-41f8-8916-8470bbacac23", "name": "Property not found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3713bbce-68e5-4a79-a481-1ca76d0e27ea", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "extras", "description": "", "item": [ { "id": "0063c78f-b88f-4578-9451-d61e978a8601", "name": "Get property extras/add-ons", "request": { "name": "Get property extras/add-ons", "description": { "content": "Retrieve bookable extras and add-ons for a property such as dogs, cots, high chairs, and log baskets. Returns a map keyed by extra type with pricing and quantity limits. Use this to display optional extras during the booking flow.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", ":id", "extras" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "98e64440-3c56-4e2f-a7df-f4f92f7ac5b5", "name": "Map of available extras keyed by extra_name_id, with pricing and quantity limits", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "extras" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": {\n \"id\": \"\",\n \"property_id\": \"\",\n \"extra_name_id\": \"\",\n \"price\": \"\",\n \"name\": \"\",\n \"max_num\": \"\",\n \"per_night\": \"\",\n \"unit\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42864bb5-39b3-4113-82b4-ce95e69ed46e", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "extras" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6085e960-09e5-40cd-91c8-231a70277488", "name": "Property not found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "extras" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4ff99eb-9c74-491a-a46b-7367b1bf9445", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "extras" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "reviews", "description": "", "item": [ { "id": "36e2c5c9-a333-47e8-b040-224467e20d2e", "name": "Get property reviews (paginated)", "request": { "name": "Get property reviews (paginated)", "description": { "content": "Retrieve published guest reviews for a property, ordered by most recent first. Returns star ratings, sub-ratings (cleanliness, location, value), review text, and guest name. Use this to display social proof on a property listing page.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", ":id", "reviews" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Reviews per page (default: 10)", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ad04214f-6492-49ec-be4d-b8384fcd0a7b", "name": "Paginated list of published reviews with ratings and review text", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "reviews" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Reviews per page (default: 10)", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"propertyId\": \"\",\n \"stars\": \"\",\n \"overallExperienceRating\": \"\",\n \"cleanlinessRating\": \"\",\n \"locationRating\": \"\",\n \"valueForMoneyRating\": \"\",\n \"dateLeft\": \"\",\n \"created\": \"\",\n \"tagLine\": \"\",\n \"comment\": \"\",\n \"customer\": \"\",\n \"reviewType\": \"\"\n },\n {\n \"id\": \"\",\n \"propertyId\": \"\",\n \"stars\": \"\",\n \"overallExperienceRating\": \"\",\n \"cleanlinessRating\": \"\",\n \"locationRating\": \"\",\n \"valueForMoneyRating\": \"\",\n \"dateLeft\": \"\",\n \"created\": \"\",\n \"tagLine\": \"\",\n \"comment\": \"\",\n \"customer\": \"\",\n \"reviewType\": \"\"\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"page\": \"\",\n \"limit\": \"\",\n \"totalPages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a27e4287-0683-4bda-b151-dcde5fb12a26", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "reviews" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Reviews per page (default: 10)", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94910873-74e0-4dbf-a9d8-5cde66735170", "name": "Property not found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "reviews" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Reviews per page (default: 10)", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed478ac4-b706-405f-b2c8-74476f9a3298", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "reviews" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Reviews per page (default: 10)", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "images", "description": "", "item": [ { "id": "75ea7bda-5fdc-4346-aa4f-9b42663b3be0", "name": "Get property images", "request": { "name": "Get property images", "description": { "content": "Retrieve all images for a property, split into legacy (original server) and GCS (Google Cloud Storage) collections. Each image includes URLs, alt text, and display ordering. Use this to build a photo gallery or carousel on the property page.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", ":id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1487faae-aa7d-4ce3-b421-6e10257e7d66", "name": "Legacy and GCS images for the property, ordered by display position", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"data\": {\n \"legacy\": [\n {\n \"id\": \"\",\n \"property_id\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"reorder\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"thumb_name\": \"\",\n \"medium_name\": \"\",\n \"image_desc\": \"\"\n },\n {\n \"id\": \"\",\n \"property_id\": \"\",\n \"name\": \"\",\n \"status\": \"inactive\",\n \"reorder\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"thumb_name\": \"\",\n \"medium_name\": \"\",\n \"image_desc\": \"\"\n }\n ],\n \"gcs\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"gcsPath\": \"\",\n \"url\": \"\",\n \"contentType\": \"\",\n \"size\": \"\",\n \"reorder\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"imageDesc\": \"\"\n },\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"gcsPath\": \"\",\n \"url\": \"\",\n \"contentType\": \"\",\n \"size\": \"\",\n \"reorder\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"imageDesc\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4e8f08c-1e3f-4a44-aff2-afdcdc7078b2", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b62f4a96-fa19-42c8-a45a-e796e26c2bab", "name": "Property not found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09625420-9dcc-473b-acae-bb32f36589be", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "images" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "bedrooms", "description": "", "item": [ { "id": "ba6de874-10b1-478e-89c6-207a3f67ea91", "name": "Get property bedroom information", "request": { "name": "Get property bedroom information", "description": { "content": "Retrieve detailed bedroom configuration for a property including bed types and sizes per room. Use this to display a bedroom breakdown on the property listing page so guests can see sleeping arrangements.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", ":id", "bedrooms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "290cee98-72e7-460b-860d-342b16f87b91", "name": "Array of bedroom configurations with bed types and counts", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "bedrooms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"bedroom_number\": \"\",\n \"bed_type\": \"\",\n \"bed_count\": \"\",\n \"en_suite\": \"\"\n },\n {\n \"bedroom_number\": \"\",\n \"bed_type\": \"\",\n \"bed_count\": \"\",\n \"en_suite\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "743182c7-d8ba-4feb-bbd3-223b93805452", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "bedrooms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5abcfd43-f68c-4ecf-b84c-da071b94b57e", "name": "Property not found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "bedrooms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6c36a69-61ba-4beb-8ad4-fe9c8b24aa58", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "bedrooms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "owner-contact", "description": "", "item": [ { "id": "85da0f93-e714-4a2b-a8e0-d7870ee05b12", "name": "Get property owner contact info", "request": { "name": "Get property owner contact info", "description": { "content": "Retrieve the property owner's contact details including name, email, and phone number. Use this to enable direct owner communication features or display owner information on the listing. Returns null data if no owner is associated with the property.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", ":id", "owner-contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "042087aa-5765-435c-b16e-86285eed99a7", "name": "Owner contact details (name, email, phone) or null if no owner found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "owner-contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d07949cb-19b0-4be4-8dac-0cd65b4bcfb2", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "owner-contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84d6b9c7-c7c8-48d8-bcd0-813e67cf3e1d", "name": "Property not found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "owner-contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccd1ad6c-d4d1-4499-a557-49ee15aec125", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "owner-contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "specialoffers", "description": "", "item": [ { "id": "2d16153a-f568-456e-8398-387642260e57", "name": "Get special offers for a specific property", "request": { "name": "Get special offers for a specific property", "description": { "content": "Retrieve current special offers and promotional prices for a single property. Returns discounted date ranges with offer prices. Use this to highlight deals on the property detail page or in a booking widget.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", ":id", "specialoffers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "84f2a6e7-d708-4d9f-ab09-5bfc9e6f9418", "name": "List of active special offers for the property", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "specialoffers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"propertyId\": \"\",\n \"price\": \"\",\n \"checkin\": \"\",\n \"checkout\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"propertyId\": \"\",\n \"price\": \"\",\n \"checkin\": \"\",\n \"checkout\": \"\",\n \"created\": \"\",\n \"modified\": \"\",\n \"description\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe944c41-ac61-4c88-9446-f221e8807b2d", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "specialoffers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72812e06-4d26-47e7-a4ce-f68e616aca43", "name": "Property not found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "specialoffers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dadcdbac-15a9-48ea-9e1e-cc5138316e1c", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "specialoffers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "unavailableDates", "description": "", "item": [ { "id": "698d2dfc-cbfe-4c7a-befc-9585c1590559", "name": "Get unavailable dates for a property", "request": { "name": "Get unavailable dates for a property", "description": { "content": "Retrieve all dates that are unavailable (booked or blocked) for a property. Returns an array of date strings that cannot be selected as check-in or stay dates. Use this to grey out dates in a calendar/datepicker widget.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", ":id", "unavailableDates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by year (optional)", "type": "text/plain" }, "key": "year", "value": "" }, { "disabled": false, "description": { "content": "Filter by month 1-12 (optional)", "type": "text/plain" }, "key": "month", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7579e2b2-f08a-4444-8225-848e6e02a52e", "name": "Array of unavailable date strings for the property calendar", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "unavailableDates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by year (optional)", "type": "text/plain" }, "key": "year", "value": "" }, { "disabled": false, "description": { "content": "Filter by month 1-12 (optional)", "type": "text/plain" }, "key": "month", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"\",\n \"\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a20f13c-603f-458a-a405-82eb9b1e0046", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "unavailableDates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by year (optional)", "type": "text/plain" }, "key": "year", "value": "" }, { "disabled": false, "description": { "content": "Filter by month 1-12 (optional)", "type": "text/plain" }, "key": "month", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e1b1c91-df05-45de-bdec-dfcb0a35e1db", "name": "Property not found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "unavailableDates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by year (optional)", "type": "text/plain" }, "key": "year", "value": "" }, { "disabled": false, "description": { "content": "Filter by month 1-12 (optional)", "type": "text/plain" }, "key": "month", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa0bde24-4161-4ba1-b006-593c6934cc48", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "unavailableDates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by year (optional)", "type": "text/plain" }, "key": "year", "value": "" }, { "disabled": false, "description": { "content": "Filter by month 1-12 (optional)", "type": "text/plain" }, "key": "month", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "startDays", "description": "", "item": [ { "id": "f2c34ef4-f262-4643-9379-6a640935d80f", "name": "Get available start days for a property", "request": { "name": "Get available start days for a property", "description": { "content": "Retrieve the days of the week on which new bookings can start for a property (e.g., Friday and Saturday only). Returns day-of-week rules that restrict check-in days. Use this to disable non-start days in your datepicker.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", ":id", "startDays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f1a1975a-8729-43d9-9291-15358db2698f", "name": "Start day rules indicating which days of the week allow check-in", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "startDays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a5ad74c-a826-41b6-93b6-48e415fd32f7", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "startDays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45ee5d5a-f4e9-47de-b0b4-1a32721d747c", "name": "Property not found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "startDays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daddb7e9-7618-43d3-8d40-013eac555b24", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "startDays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "shortBreaks", "description": "", "item": [ { "id": "c3205f33-fb1a-4ba0-a4fc-781f6d60f762", "name": "Get short break rules for a property", "request": { "name": "Get short break rules for a property", "description": { "content": "Retrieve short break configuration for a property including minimum night requirements, allowed start days, and seasonal rules. Use this to determine whether short stays (less than 7 nights) are available and on which dates.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", ":id", "shortBreaks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ad1b1951-e555-413e-93b8-89a7a985284b", "name": "Short break rules including minimum nights and seasonal availability", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "shortBreaks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64a3777e-814b-4753-a53a-758a9689709a", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "shortBreaks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a548ad9c-0127-4631-9349-3f543317e20b", "name": "Property not found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "shortBreaks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d9c6b4d-df7a-45d4-96ac-3f988a4861f0", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "shortBreaks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "start-dates", "description": "", "item": [ { "id": "2147ddd2-c42b-49b5-bf4e-0ef4aa218d49", "name": "Get available start dates for next N months", "request": { "name": "Get available start dates for next N months", "description": { "content": "Retrieve specific available check-in dates for a property over the next N months. Unlike startDays (which returns day-of-week rules), this returns actual calendar dates that are open for new bookings. Use this to populate an availability calendar with selectable dates.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", ":id", "start-dates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of months to look ahead (default: 3)", "type": "text/plain" }, "key": "months", "value": "3" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "af08e66d-f2d6-4d58-91c6-54f4778b981a", "name": "Array of available start dates for the requested period", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "start-dates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of months to look ahead (default: 3)", "type": "text/plain" }, "key": "months", "value": "3" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "052b6000-060c-4487-b7c2-6dadf3110c8e", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "start-dates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of months to look ahead (default: 3)", "type": "text/plain" }, "key": "months", "value": "3" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9fa6c2d-6caa-4c93-9caf-53c4d3927fe2", "name": "Property not found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "start-dates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of months to look ahead (default: 3)", "type": "text/plain" }, "key": "months", "value": "3" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "524083b6-087c-460b-b1f5-6363db9448ae", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "start-dates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of months to look ahead (default: 3)", "type": "text/plain" }, "key": "months", "value": "3" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "get-price", "description": "", "item": [ { "id": "91b0a028-1f97-467b-bb05-e116cc35c036", "name": "Calculate price for a property stay", "request": { "name": "Calculate price for a property stay", "description": { "content": "Calculate the total price for a property stay including any applicable discounts, cleaning fees, and service fees. Returns the property charge, discount amount, final total in GBP, number of nights, and price per night. A response code of 0 means available; non-zero codes indicate conflicts or restrictions. Call this before creating a booking to show the guest accurate pricing.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", ":id", "get-price" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"num_nights\": \"\",\n \"end_date\": \"\",\n \"num_guests\": \"\",\n \"skip_conflict_check\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "21503018-b28e-4b54-8373-e033ec1f6c88", "name": "Price calculation result with total, fees, discounts, and availability status", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "get-price" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"num_nights\": \"\",\n \"end_date\": \"\",\n \"num_guests\": \"\",\n \"skip_conflict_check\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"response\": \"\",\n \"price\": \"\",\n \"final_total_price\": \"\",\n \"normal_price\": \"\",\n \"apply_price\": \"monthly\",\n \"cleaning_fee\": \"\",\n \"service_fee\": \"\",\n \"service_apply\": \"no\",\n \"security_deposit\": \"\",\n \"is_special_price\": \"no\",\n \"type\": \"\",\n \"discount\": {\n \"type\": \"\",\n \"amount\": \"\",\n \"percentage\": \"\"\n },\n \"applicable_discount\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5def86e1-65b4-4090-82ac-608c1c438695", "name": "Bad request — malformed body", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "get-price" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"num_nights\": \"\",\n \"end_date\": \"\",\n \"num_guests\": \"\",\n \"skip_conflict_check\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76ac3899-aca8-4dfb-aa4b-63aee3543d34", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "get-price" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"num_nights\": \"\",\n \"end_date\": \"\",\n \"num_guests\": \"\",\n \"skip_conflict_check\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57283fae-3988-4f19-9b6d-decb73fc3077", "name": "Property not found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "get-price" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"num_nights\": \"\",\n \"end_date\": \"\",\n \"num_guests\": \"\",\n \"skip_conflict_check\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9863831a-68fa-4fcd-b585-253ac3f28bf4", "name": "Validation failed — check message array for details", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "get-price" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"num_nights\": \"\",\n \"end_date\": \"\",\n \"num_guests\": \"\",\n \"skip_conflict_check\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55a9f41d-9bdf-4452-b9f0-b9501ffe81f5", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "get-price" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"num_nights\": \"\",\n \"end_date\": \"\",\n \"num_guests\": \"\",\n \"skip_conflict_check\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "available-nights", "description": "", "item": [ { "id": "8ef864c3-771c-453e-b545-fb7063332cef", "name": "Get available nights from a check-in date", "request": { "name": "Get available nights from a check-in date", "description": { "content": "Given a check-in date, returns the valid night durations available for a property (e.g., 3, 4, 7, 14 nights). Takes into account subsequent bookings, minimum stay rules, and short break configuration. Use this to populate a \"number of nights\" dropdown after the guest selects a check-in date.\n", "type": "text/plain" }, "url": { "path": [ "developer", "properties", ":id", "available-nights" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6e1cdb5c-e5ce-4a23-bbe2-f17b8c9b37e9", "name": "Array of valid night durations available from the given check-in date", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "available-nights" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"\",\n \"\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a97ab86-03ad-4c29-bd51-c18fa93eea97", "name": "Bad request — malformed body", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "available-nights" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec258c99-ac0b-44a6-85a4-e8f8901a8dc4", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "available-nights" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26bd1d28-1693-4868-9543-3711ece5799e", "name": "Property not found", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "available-nights" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15d69224-02c0-4c22-8cde-3acfcfaa4f23", "name": "Validation failed — check message array for details", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "available-nights" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe1a0abb-a556-41d2-9157-c3399e5c5bd6", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "properties", ":id", "available-nights" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Property ID", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "{placeSlug}", "description": "", "item": [ { "name": "{propertySlug}", "description": "", "item": [ { "id": "1f87f382-dac2-49e6-bb82-c14d42290af0", "name": "Get property by place and property slug", "request": { "name": "Get property by place and property slug", "description": { "content": "Look up a property using its URL-friendly slugs (place and property). Returns the same full detail as getPropertyById. Use this when you have a human-readable URL like \"/porlock/meadow-cottage\" rather than a numeric ID.\n", "type": "text/plain" }, "url": { "path": [ "developer", ":placeSlug", ":propertySlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "placeSlug", "disabled": false, "description": { "content": "(Required) Place slug (e.g., \"porlock\", \"north-devon\")", "type": "text/plain" } }, { "type": "any", "value": "", "key": "propertySlug", "disabled": false, "description": { "content": "(Required) Property slug (e.g., \"meadow-cottage\")", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1b27ad2e-0a83-4547-93e8-cb0cf2318d94", "name": "Full property details resolved from the slug pair", "originalRequest": { "url": { "path": [ "developer", ":placeSlug", ":propertySlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Place slug (e.g., \"porlock\", \"north-devon\")", "type": "text/plain" }, "type": "any", "value": "", "key": "placeSlug" }, { "disabled": false, "description": { "content": "(Required) Property slug (e.g., \"meadow-cottage\")", "type": "text/plain" }, "type": "any", "value": "", "key": "propertySlug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"title\": \"\",\n \"slug\": \"\",\n \"is_pets\": \"\",\n \"status\": \"active\",\n \"live\": \"no\",\n \"online\": \"no\",\n \"modified\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip_code\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"description\": \"\",\n \"things_to_do\": \"\",\n \"food_and_drinks\": \"\",\n \"walk_and_beaches\": \"\",\n \"search_summary\": \"\",\n \"bed_rooms\": \"\",\n \"total_guest\": \"\",\n \"additional_guest\": \"\",\n \"free_guest\": \"\",\n \"single_beds\": \"\",\n \"double_beds\": \"\",\n \"king_beds\": \"\",\n \"sofa_beds\": \"\",\n \"cots\": \"\",\n \"bath_rooms\": \"\",\n \"family_bathrooms\": \"\",\n \"en_suites\": \"\",\n \"shower_rooms\": \"\",\n \"price_per_night\": \"\",\n \"price_per_week\": \"\",\n \"min_price\": \"\",\n \"apply_price\": \"fixed\",\n \"additional_guest_price\": \"\",\n \"security_deposit\": \"\",\n \"security_deposit_info\": \"\",\n \"amenities_set\": \"\",\n \"holiday_types_set\": \"\",\n \"indoors_set\": \"\",\n \"indoor_description\": \"\",\n \"outdoors_set\": \"\",\n \"outdoor_description\": \"\",\n \"parking\": \"\",\n \"max_vehicle_allowed\": \"\",\n \"ev_charge_note\": \"\",\n \"wifi_download_speed\": \"\",\n \"wifi_upload_speed\": \"\",\n \"checkin\": \"\",\n \"checkout\": \"\",\n \"house_rules\": \"\",\n \"suitable_type_set\": \"\",\n \"children_suitable\": \"\",\n \"pets_suitable\": \"\",\n \"cat_note\": \"\",\n \"mobility_suitable\": \"\",\n \"restricted_mobility_note\": \"\",\n \"property_place_id\": \"\",\n \"property_place_slug\": \"\",\n \"region\": \"\",\n \"area\": \"\",\n \"airport_name\": \"\",\n \"airport_distance\": \"\",\n \"trainStation_name\": \"\",\n \"trainStation_distance\": \"\",\n \"nearestbeach_name\": \"\",\n \"nearestbeach_distance\": \"\",\n \"nearestshop_distance\": \"\",\n \"tip_get_there\": \"\",\n \"youtube_url\": \"\",\n \"virtualTour_url\": \"\",\n \"created\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2a2cfed-53d0-44ed-ae0c-5592001e70f0", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", ":placeSlug", ":propertySlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Place slug (e.g., \"porlock\", \"north-devon\")", "type": "text/plain" }, "type": "any", "value": "", "key": "placeSlug" }, { "disabled": false, "description": { "content": "(Required) Property slug (e.g., \"meadow-cottage\")", "type": "text/plain" }, "type": "any", "value": "", "key": "propertySlug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2801bb0d-a378-4b6b-9eed-4ce899b75c9e", "name": "Property not found for the given slug combination", "originalRequest": { "url": { "path": [ "developer", ":placeSlug", ":propertySlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Place slug (e.g., \"porlock\", \"north-devon\")", "type": "text/plain" }, "type": "any", "value": "", "key": "placeSlug" }, { "disabled": false, "description": { "content": "(Required) Property slug (e.g., \"meadow-cottage\")", "type": "text/plain" }, "type": "any", "value": "", "key": "propertySlug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62a07f20-695c-45b9-a23f-88ae249f6cd9", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", ":placeSlug", ":propertySlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Place slug (e.g., \"porlock\", \"north-devon\")", "type": "text/plain" }, "type": "any", "value": "", "key": "placeSlug" }, { "disabled": false, "description": { "content": "(Required) Property slug (e.g., \"meadow-cottage\")", "type": "text/plain" }, "type": "any", "value": "", "key": "propertySlug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "bookings", "description": "", "item": [ { "name": "save", "description": "", "item": [ { "id": "08cba9d1-eef5-45f9-8d18-f27f5168fa9f", "name": "Submit a booking", "request": { "name": "Submit a booking", "description": { "content": "Submit a new booking with guest details, dates, and pricing. The booking is attributed to your API key's client name for tracking in the admin dashboard. In sandbox mode, returns a mock response without creating an actual booking. Always call calculatePrice first to get the correct property_charge before submitting.\n", "type": "text/plain" }, "url": { "path": [ "developer", "bookings", "save" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"property_id\": \"\",\n \"checkin\": \"\",\n \"checkout\": \"\",\n \"nights\": \"\",\n \"guests\": \"\",\n \"property_charge\": \"\",\n \"User\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "be6e9d7b-66bf-473d-8729-871fdfc4cb3b", "name": "Booking confirmation with booking ID, status, and guest details", "originalRequest": { "url": { "path": [ "developer", "bookings", "save" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"property_id\": \"\",\n \"checkin\": \"\",\n \"checkout\": \"\",\n \"nights\": \"\",\n \"guests\": \"\",\n \"property_charge\": \"\",\n \"User\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"booking_id\": \"\",\n \"status\": \"\",\n \"property_id\": \"\",\n \"checkin_date\": \"\",\n \"checkout_date\": \"\",\n \"num_nights\": \"\",\n \"num_guests\": \"\",\n \"guest_first_name\": \"\",\n \"guest_last_name\": \"\",\n \"guest_email\": \"\",\n \"total_amount\": \"\",\n \"currency\": \"\",\n \"booked_site\": \"\",\n \"message\": \"\",\n \"sandbox\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6588e18-da57-4d5a-944b-9cd9c9e5e65f", "name": "Bad request — malformed body", "originalRequest": { "url": { "path": [ "developer", "bookings", "save" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"property_id\": \"\",\n \"checkin\": \"\",\n \"checkout\": \"\",\n \"nights\": \"\",\n \"guests\": \"\",\n \"property_charge\": \"\",\n \"User\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "981c51e2-663c-4080-9b93-a59c5c7d20cd", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "bookings", "save" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"property_id\": \"\",\n \"checkin\": \"\",\n \"checkout\": \"\",\n \"nights\": \"\",\n \"guests\": \"\",\n \"property_charge\": \"\",\n \"User\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1341524-6b1f-426a-9aeb-267ce88edccb", "name": "Validation failed — check message array for details", "originalRequest": { "url": { "path": [ "developer", "bookings", "save" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"property_id\": \"\",\n \"checkin\": \"\",\n \"checkout\": \"\",\n \"nights\": \"\",\n \"guests\": \"\",\n \"property_charge\": \"\",\n \"User\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b130ad6-6f55-4440-8f80-2970cf6358a1", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "bookings", "save" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"property_id\": \"\",\n \"checkin\": \"\",\n \"checkout\": \"\",\n \"nights\": \"\",\n \"guests\": \"\",\n \"property_charge\": \"\",\n \"User\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "validate-voucher", "description": "", "item": [ { "id": "6bb7463c-95b8-4e2a-a34b-f10d4d4b5ef1", "name": "Validate a discount voucher", "request": { "name": "Validate a discount voucher", "description": { "content": "Validate a voucher code against a specific property, stay dates, and total price. Returns whether the voucher is valid, the discount type and amount, and the updated total price after discount. Use this in the booking flow to let guests apply promo codes before payment.\n", "type": "text/plain" }, "url": { "path": [ "developer", "bookings", "validate-voucher" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"voucher_code\": \"\",\n \"property_id\": \"\",\n \"num_nights\": \"\",\n \"checkin_date\": \"\",\n \"total_price\": \"\",\n \"guest_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5100fb45-5c8b-48d0-9aa5-a57aabb45bff", "name": "Voucher validation result with discount details and adjusted price", "originalRequest": { "url": { "path": [ "developer", "bookings", "validate-voucher" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"voucher_code\": \"\",\n \"property_id\": \"\",\n \"num_nights\": \"\",\n \"checkin_date\": \"\",\n \"total_price\": \"\",\n \"guest_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"valid\": \"\",\n \"voucher_code\": \"\",\n \"discount_type\": \"fixed\",\n \"discount_value\": \"\",\n \"discounted_price\": \"\",\n \"original_price\": \"\",\n \"message\": \"\",\n \"property_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "020b19b1-46d4-4c63-9c3b-b6f73743f73a", "name": "Bad request — malformed body", "originalRequest": { "url": { "path": [ "developer", "bookings", "validate-voucher" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"voucher_code\": \"\",\n \"property_id\": \"\",\n \"num_nights\": \"\",\n \"checkin_date\": \"\",\n \"total_price\": \"\",\n \"guest_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72d9f11d-5d22-4a64-89d4-4cc0b463d745", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "bookings", "validate-voucher" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"voucher_code\": \"\",\n \"property_id\": \"\",\n \"num_nights\": \"\",\n \"checkin_date\": \"\",\n \"total_price\": \"\",\n \"guest_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d2088c3-ec34-4468-8065-e07d2ffa6c15", "name": "Validation failed — check message array for details", "originalRequest": { "url": { "path": [ "developer", "bookings", "validate-voucher" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"voucher_code\": \"\",\n \"property_id\": \"\",\n \"num_nights\": \"\",\n \"checkin_date\": \"\",\n \"total_price\": \"\",\n \"guest_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0f24899-db54-447e-bdef-d7381fbe29da", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "bookings", "validate-voucher" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"voucher_code\": \"\",\n \"property_id\": \"\",\n \"num_nights\": \"\",\n \"checkin_date\": \"\",\n \"total_price\": \"\",\n \"guest_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "processPayment", "description": "", "item": [ { "id": "36cf2030-6241-494a-801b-c287c09342d0", "name": "Process a payment via SagePay", "request": { "name": "Process a payment via SagePay", "description": { "content": "Process a card payment for an existing booking via the SagePay/Opayo gateway. Returns either a success confirmation or a 3D Secure redirect URL if additional cardholder authentication is required. Sandbox API keys cannot process real payments and will receive an error. Card details are transmitted securely and never stored.\n", "type": "text/plain" }, "url": { "path": [ "developer", "bookings", "processPayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_id\": \"\",\n \"card_holder\": \"\",\n \"card_number\": \"36043210954654336\",\n \"expiry_date\": \"3352\",\n \"security_code\": \"616\",\n \"amount\": \"\",\n \"payment_type\": \"deposit\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "077df4f2-e0be-4670-863c-5c21cbfd677b", "name": "Payment result — either success confirmation or 3DS redirect details", "originalRequest": { "url": { "path": [ "developer", "bookings", "processPayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_id\": \"\",\n \"card_holder\": \"\",\n \"card_number\": \"36043210954654336\",\n \"expiry_date\": \"3352\",\n \"security_code\": \"616\",\n \"amount\": \"\",\n \"payment_type\": \"deposit\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"status\": \"3ds_required\",\n \"transactionId\": \"\",\n \"booking_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"acsUrl\": \"\",\n \"cReq\": \"\",\n \"threeDSSessionData\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"sandbox\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11591216-3a1d-4007-ad3e-52aa0105ac43", "name": "Bad request — malformed body", "originalRequest": { "url": { "path": [ "developer", "bookings", "processPayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_id\": \"\",\n \"card_holder\": \"\",\n \"card_number\": \"36043210954654336\",\n \"expiry_date\": \"3352\",\n \"security_code\": \"616\",\n \"amount\": \"\",\n \"payment_type\": \"deposit\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10804459-6738-44f1-a716-8a50af7505b9", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "bookings", "processPayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_id\": \"\",\n \"card_holder\": \"\",\n \"card_number\": \"36043210954654336\",\n \"expiry_date\": \"3352\",\n \"security_code\": \"616\",\n \"amount\": \"\",\n \"payment_type\": \"deposit\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dab84ea-f13f-4381-85ea-18062d4d22b0", "name": "Validation failed — check message array for details", "originalRequest": { "url": { "path": [ "developer", "bookings", "processPayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_id\": \"\",\n \"card_holder\": \"\",\n \"card_number\": \"36043210954654336\",\n \"expiry_date\": \"3352\",\n \"security_code\": \"616\",\n \"amount\": \"\",\n \"payment_type\": \"deposit\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17ea4318-1a44-441d-9044-42d518e4a0ae", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "bookings", "processPayment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_id\": \"\",\n \"card_holder\": \"\",\n \"card_number\": \"36043210954654336\",\n \"expiry_date\": \"3352\",\n \"security_code\": \"616\",\n \"amount\": \"\",\n \"payment_type\": \"deposit\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "places", "description": "", "item": [ { "id": "9ab9dd14-632f-45b4-a74f-00875e43ba7b", "name": "Get all property places/locations", "request": { "name": "Get all property places/locations", "description": { "content": "Retrieve all active destination areas (places) where properties are listed. Returns place names, slugs, coordinates, cover photos, and descriptions. Use this to build a location picker, homepage destination grid, or map-based navigation.\n", "type": "text/plain" }, "url": { "path": [ "developer", "places" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0766bb37-6645-4526-bc77-0d3813237fa7", "name": "List of all active places with names, slugs, coordinates, and cover photos", "originalRequest": { "url": { "path": [ "developer", "places" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"placeCoverPhoto\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"status\": \"active\",\n \"created\": \"\",\n \"modified\": \"\",\n \"pageDescription\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"placeCoverPhoto\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"status\": \"active\",\n \"created\": \"\",\n \"modified\": \"\",\n \"pageDescription\": \"\"\n }\n ],\n \"meta\": {\n \"count\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4081b85d-664e-4b32-b557-b764bc07290a", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "places" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5eb6d769-f0e6-4e3f-96d5-59676303c829", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "places" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{slug}", "description": "", "item": [ { "id": "dc91ca68-0bea-45b1-91c9-3e59ddf29032", "name": "Get properties by place slug", "request": { "name": "Get properties by place slug", "description": { "content": "Retrieve all properties within a specific place/destination area, with optional filters for guests, check-in date, and number of nights. Returns paginated property summaries. Use this to build a destination landing page showing all available properties in an area.\n", "type": "text/plain" }, "url": { "path": [ "developer", "places", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of guests to filter by", "type": "text/plain" }, "key": "guests", "value": "" }, { "disabled": false, "description": { "content": "Check-in date (YYYY-MM-DD)", "type": "text/plain" }, "key": "checkin", "value": "" }, { "disabled": false, "description": { "content": "Number of nights", "type": "text/plain" }, "key": "nights", "value": "" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Results per page (default: 20)", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [ { "type": "any", "value": "", "key": "slug", "disabled": false, "description": { "content": "(Required) Place slug (e.g., \"porlock\", \"north-devon\", \"exmoor\")", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "417e6499-7b84-42d1-b791-82425bab3c77", "name": "Paginated list of properties in the specified place", "originalRequest": { "url": { "path": [ "developer", "places", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of guests to filter by", "type": "text/plain" }, "key": "guests", "value": "" }, { "disabled": false, "description": { "content": "Check-in date (YYYY-MM-DD)", "type": "text/plain" }, "key": "checkin", "value": "" }, { "disabled": false, "description": { "content": "Number of nights", "type": "text/plain" }, "key": "nights", "value": "" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Results per page (default: 20)", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Place slug (e.g., \"porlock\", \"north-devon\", \"exmoor\")", "type": "text/plain" }, "type": "any", "value": "", "key": "slug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"slug\": \"\",\n \"is_pets\": \"\",\n \"status\": \"inactive\",\n \"property_place_slug\": \"\",\n \"bed_rooms\": \"\",\n \"total_guest\": \"\",\n \"bath_rooms\": \"\",\n \"min_price\": \"\",\n \"price_per_night\": \"\",\n \"price_per_week\": \"\",\n \"apply_price\": \"monthly\",\n \"thumbnailUrl\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"search_summary\": \"\",\n \"rating\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"slug\": \"\",\n \"is_pets\": \"\",\n \"status\": \"active\",\n \"property_place_slug\": \"\",\n \"bed_rooms\": \"\",\n \"total_guest\": \"\",\n \"bath_rooms\": \"\",\n \"min_price\": \"\",\n \"price_per_night\": \"\",\n \"price_per_week\": \"\",\n \"apply_price\": \"monthly\",\n \"thumbnailUrl\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"search_summary\": \"\",\n \"rating\": \"\"\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"page\": \"\",\n \"limit\": \"\",\n \"totalPages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d882ba2-1db5-427c-a9ac-b5988d9d3bc3", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "places", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of guests to filter by", "type": "text/plain" }, "key": "guests", "value": "" }, { "disabled": false, "description": { "content": "Check-in date (YYYY-MM-DD)", "type": "text/plain" }, "key": "checkin", "value": "" }, { "disabled": false, "description": { "content": "Number of nights", "type": "text/plain" }, "key": "nights", "value": "" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Results per page (default: 20)", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Place slug (e.g., \"porlock\", \"north-devon\", \"exmoor\")", "type": "text/plain" }, "type": "any", "value": "", "key": "slug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "491a1b3e-4ee9-4c94-aef7-d23427ba32cf", "name": "Place not found for the given slug", "originalRequest": { "url": { "path": [ "developer", "places", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of guests to filter by", "type": "text/plain" }, "key": "guests", "value": "" }, { "disabled": false, "description": { "content": "Check-in date (YYYY-MM-DD)", "type": "text/plain" }, "key": "checkin", "value": "" }, { "disabled": false, "description": { "content": "Number of nights", "type": "text/plain" }, "key": "nights", "value": "" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Results per page (default: 20)", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Place slug (e.g., \"porlock\", \"north-devon\", \"exmoor\")", "type": "text/plain" }, "type": "any", "value": "", "key": "slug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a118878b-9845-4ac4-9a1c-495f39f259c3", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "places", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Number of guests to filter by", "type": "text/plain" }, "key": "guests", "value": "" }, { "disabled": false, "description": { "content": "Check-in date (YYYY-MM-DD)", "type": "text/plain" }, "key": "checkin", "value": "" }, { "disabled": false, "description": { "content": "Number of nights", "type": "text/plain" }, "key": "nights", "value": "" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Results per page (default: 20)", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Place slug (e.g., \"porlock\", \"north-devon\", \"exmoor\")", "type": "text/plain" }, "type": "any", "value": "", "key": "slug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "usage", "description": "", "item": [ { "name": "stats", "description": "", "item": [ { "id": "f67361c9-44fc-46c2-b89e-063985d64eb3", "name": "Get API usage statistics for a client", "request": { "name": "Get API usage statistics for a client", "description": { "content": "Retrieve aggregated API usage statistics for a specific client, optionally filtered by date range. Returns call counts, endpoint breakdowns, and error rates. Use this to monitor your integration's API consumption and identify usage patterns.\n", "type": "text/plain" }, "url": { "path": [ "developer", "usage", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Client ID to retrieve usage stats for", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Start date for the stats period (YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "End date for the stats period (YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4c26708d-b848-42be-afd1-9aa2faf9e90a", "name": "Aggregated usage statistics including call counts and endpoint breakdowns", "originalRequest": { "url": { "path": [ "developer", "usage", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Client ID to retrieve usage stats for", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Start date for the stats period (YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "End date for the stats period (YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"data\": {\n \"total_calls\": \"\",\n \"period\": {\n \"start_date\": \"\",\n \"end_date\": \"\"\n },\n \"endpoints\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"error_count\": \"\",\n \"error_rate\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe45129b-5d78-4843-82af-e52fa77511af", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "usage", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Client ID to retrieve usage stats for", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Start date for the stats period (YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "End date for the stats period (YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a7cd58e-f213-4272-8783-d8f20cdc94a5", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "usage", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Client ID to retrieve usage stats for", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Start date for the stats period (YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "End date for the stats period (YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "logs", "description": "", "item": [ { "id": "de387bea-5c71-4371-a878-1bfaff3182b1", "name": "Get paginated API usage logs", "request": { "name": "Get paginated API usage logs", "description": { "content": "Retrieve detailed, paginated API usage logs showing every request made by a client. Each log entry includes the endpoint called, response status, response time, and timestamp. Use this for debugging, auditing, and detailed usage analysis.\n", "type": "text/plain" }, "url": { "path": [ "developer", "usage", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by client ID", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Filter by endpoint path", "type": "text/plain" }, "key": "endpoint", "value": "" }, { "disabled": false, "description": { "content": "Filter by property ID", "type": "text/plain" }, "key": "property_id", "value": "" }, { "disabled": false, "description": { "content": "Start date (ISO format)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "End date (ISO format)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (default: 50)", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "80db9231-a718-488e-b3d3-384abdbe12b3", "name": "Paginated list of individual API call log entries with request/response details", "originalRequest": { "url": { "path": [ "developer", "usage", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by client ID", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Filter by endpoint path", "type": "text/plain" }, "key": "endpoint", "value": "" }, { "disabled": false, "description": { "content": "Filter by property ID", "type": "text/plain" }, "key": "property_id", "value": "" }, { "disabled": false, "description": { "content": "Start date (ISO format)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "End date (ISO format)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (default: 50)", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"client_id\": \"\",\n \"endpoint\": \"\",\n \"status_code\": \"\",\n \"response_time_ms\": \"\",\n \"property_id\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"client_id\": \"\",\n \"endpoint\": \"\",\n \"status_code\": \"\",\n \"response_time_ms\": \"\",\n \"property_id\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"meta\": {\n \"total\": \"\",\n \"page\": \"\",\n \"limit\": \"\",\n \"totalPages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33e24d48-c37e-429d-99c1-d4badf8f87e2", "name": "Invalid API key, IP not whitelisted, or origin not allowed", "originalRequest": { "url": { "path": [ "developer", "usage", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by client ID", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Filter by endpoint path", "type": "text/plain" }, "key": "endpoint", "value": "" }, { "disabled": false, "description": { "content": "Filter by property ID", "type": "text/plain" }, "key": "property_id", "value": "" }, { "disabled": false, "description": { "content": "Start date (ISO format)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "End date (ISO format)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (default: 50)", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "246db305-77d3-4678-9805-2f3657978c77", "name": "Rate limit exceeded — check Retry-After header", "originalRequest": { "url": { "path": [ "developer", "usage", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by client ID", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Filter by endpoint path", "type": "text/plain" }, "key": "endpoint", "value": "" }, { "disabled": false, "description": { "content": "Filter by property ID", "type": "text/plain" }, "key": "property_id", "value": "" }, { "disabled": false, "description": { "content": "Start date (ISO format)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "End date (ISO format)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Page number (default: 1)", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page (default: 50)", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-API-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\",\n \"retryAfter\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "X-API-Key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://app.bookingbrain.com/api/v2" } ], "info": { "_postman_id": "c87fac3b-e7e2-4fa0-ba80-0360efc6e404", "name": "Booking Brain Developer API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "# Booking Brain Developer API\n\nThe Booking Brain Developer API gives you full programmatic access to holiday rental\nproperty search, availability, pricing, booking, and payment — everything you need\nto build a custom booking experience on top of the Booking Brain platform.\n\n## Authentication\n\nEvery request must include an `X-API-Key` header. Keys are issued per-client and\nscoped to specific IP addresses and origins.\n\n```\nX-API-Key: bb_sandbox_test_key_do_not_use_in_production\n```\n\n**Sandbox keys** are available for development and testing. They return real search\nand property data but will not create actual bookings or process payments.\n\n## Rate Limiting\n\nEach API key has a configurable rate limit. When you exceed it, the API returns\n`429 Too Many Requests` with a `Retry-After` header indicating how many seconds\nto wait before retrying.\n\n## Pagination\n\nList endpoints return paginated results. Use `page` (1-based) and `limit` query\nparameters to navigate. Response metadata includes `total`, `page`, `limit`, and\n`totalPages` (or equivalent fields).\n\n## Error Handling\n\nAll errors follow a consistent shape:\n\n```json\n{\n \"statusCode\": 403,\n \"message\": \"Forbidden\",\n \"error\": \"Forbidden\"\n}\n```\n\nValidation errors (422) return `message` as an array of human-readable strings.\n\n## Typical Booking Flow\n\n1. **Search** — `GET /developer/search` to find properties\n2. **Detail** — `GET /developer/properties/{id}` for full listing info\n3. **Availability** — `GET /developer/properties/{id}/unavailableDates` to populate a calendar\n4. **Pricing** — `POST /developer/properties/{id}/get-price` to calculate the total\n5. **Book** — `POST /developer/bookings/save` to create the reservation\n6. **Pay** — `POST /developer/bookings/processPayment` to charge the guest's card\n\n\nContact Support:\n Name: Booking Brain Support\n Email: support@bookingbrain.co.uk", "type": "text/plain" } } }