Search

Search via a variety of possible options

Auth-Free feature.

Search by stars

Endpoint

GET https://yourdomain.com/bookyflow/api/search/stars/0

Response Example

Status: OK (200)

{
  "data": {
    "search_results": {
      "6": {
        "property_name": "Some Other Yacht",
        "property_street": "motor",
        "property_town": "Bristol",
        "property_postcode": "1200bhp",
        "property_region": "Bristol, City of",
        "property_region_id": "1100",
        "property_country": "United Kingdom",
        "property_country_code": "GB",
        "property_tel": "3432423432433",
        "property_email": "your@email.com",
        "stars": 4,
        "cat_id": 0,
        "images": [
          [
            {
              "large": "/bookyflow/uploadedimages/6/property/0/4.jpg",
              "medium": "/bookyflow/uploadedimages/6/property/0/medium/4.jpg",
              "small": "/bookyflow/uploadedimages/6/property/0/thumbnail/4.jpg"
            }
          ]
        ],
        "property_details_page": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=viewproperty&property_uid=6",
        "bookthis_link": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=dobooking&selectedProperty=6",
        "bookthis_text": "Book now!"
      }
    }
  },
  "meta": {
    "code": 200
  }
}

Search by dates

Endpoint

GET https://yourdomain.com/bookyflow/api/search/dates/2022-06-09/2022-06-12

Response Example

Status: OK (200)

{
  "data": {
    "search_results": {
      "1": {
        "property_name": "Hotel Valle",
        "property_street": "Asheldon Rd",
        "property_town": "Torquay",
        "property_postcode": "TQ1 2QS",
        "property_region": "Devon",
        "property_region_id": "1113",
        "property_country": "United Kingdom",
        "property_country_code": "GB",
        "property_tel": "01000 123456",
        "stars": 3,
        "cat_id": 1,
        "images": [
          [
            {
              "large": "http://localhost/wordpress-5.9.3/bookyflow/uploadedimages/1/property/0/sample_12.jpg",
              "medium": "http://localhost/wordpress-5.9.3/bookyflow/uploadedimages/1/property/0/medium/sample_12.jpg",
              "small": "http://localhost/wordpress-5.9.3/bookyflow/uploadedimages/1/property/0/thumbnail/sample_12.jpg"
            }
          ]
        ],
        "property_details_page": "http://localhost/wordpress-5.9.3/index.php?option=com_bookyflow&page_id=7&task=viewproperty&property_uid=1",
        "bookthis_link": "http://localhost/wordpress-5.9.3/index.php?option=com_bookyflow&page_id=7&task=dobooking&selectedProperty=1",
        "bookthis_text": "Book now!"
      },
      "3": {
        "property_name": "Yacht Nicole",
        "property_street": "A Street",
        "property_town": "Buriram",
        "property_postcode": "AB12 34XY",
        "property_region": "Buriram",
        "property_region_id": "3450",
        "property_country": "Thailand",
        "property_country_code": "TH",
        "property_tel": "01234 567890",
        "stars": 0,
        "cat_id": 1,
  ...
  (Response truncated for brevity)
}

Search by price

Endpoint

GET https://yourdomain.com/bookyflow/api/search/price/{{search_price_low}}/{{search_price_high}}

Path Parameters

Parameter Description
{{search_price_low}} (Required parameter)
{{search_price_high}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "search_results": {
      "1": {
        "property_name": "Fawlty Towers",
        "property_street": "Asheldon Rd",
        "property_town": "Torquay",
        "property_postcode": "TQ1 2QS",
        "property_region": "Devon",
        "property_region_id": "1113",
        "property_country": "United Kingdom",
        "property_country_code": "GB",
        "property_tel": "34693544145",
        "property_email": "your@email.com",
        "stars": 3,
        "cat_id": 1,
        "images": [
          [
            {
              "large": "/bookyflow/uploadedimages/1/property/0/alpha.png",
              "medium": "/bookyflow/uploadedimages/1/property/0/medium/alpha.png",
              "small": "/bookyflow/uploadedimages/1/property/0/thumbnail/alpha.png"
            },
            {
              "small": "/bookyflow/uploadedimages/1/property/0/thumbnail/carryon_brexit_team.jpg",
              "medium": "/bookyflow/uploadedimages/1/property/0/medium/carryon_brexit_team.jpg",
              "large": "/bookyflow/uploadedimages/1/property/0/carryon_brexit_team.jpg"
            },
            {
              "medium": "/bookyflow/uploadedimages/1/property/0/medium/daily_cunts___.png",
              "large": "/bookyflow/uploadedimages/1/property/0/daily_cunts___.png",
              "small": "/bookyflow/uploadedimages/1/property/0/thumbnail/daily_cunts___.png"
            }
          ]
        ],
        "property_details_page": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=viewproperty&property_uid=1",
        "bookthis_link": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=dobooking&selectedProperty=1",
        "bookthis_text": "Book now!"
      },
      "13": {
  ...
  (Response truncated for brevity)
}

Search by features

Endpoint

GET https://yourdomain.com/bookyflow/api/search/features/{{search_features_ids}}

Path Parameters

Parameter Description
{{search_features_ids}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "search_results": {
      "1": {
        "property_name": "Fawlty Towers",
        "property_street": "Asheldon Rd",
        "property_town": "Torquay",
        "property_postcode": "TQ1 2QS",
        "property_region": "Devon",
        "property_region_id": "1113",
        "property_country": "United Kingdom",
        "property_country_code": "GB",
        "property_tel": "34693544145",
        "property_email": "your@email.com",
        "stars": 3,
        "cat_id": 1,
        "images": [
          [
            {
              "large": "/bookyflow/uploadedimages/1/property/0/alpha.png",
              "medium": "/bookyflow/uploadedimages/1/property/0/medium/alpha.png",
              "small": "/bookyflow/uploadedimages/1/property/0/thumbnail/alpha.png"
            },
            {
              "small": "/bookyflow/uploadedimages/1/property/0/thumbnail/carryon_brexit_team.jpg",
              "medium": "/bookyflow/uploadedimages/1/property/0/medium/carryon_brexit_team.jpg",
              "large": "/bookyflow/uploadedimages/1/property/0/carryon_brexit_team.jpg"
            },
            {
              "medium": "/bookyflow/uploadedimages/1/property/0/medium/daily_cunts___.png",
              "large": "/bookyflow/uploadedimages/1/property/0/daily_cunts___.png",
              "small": "/bookyflow/uploadedimages/1/property/0/thumbnail/daily_cunts___.png"
            }
          ]
        ],
        "property_details_page": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=viewproperty&property_uid=1",
        "bookthis_link": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=dobooking&selectedProperty=1",
        "bookthis_text": "Book now!"
      },
      "30": {
  ...
  (Response truncated for brevity)
}

Search by towns

Endpoint

GET https://yourdomain.com/bookyflow/api/search/towns/{{search_towns}}

Town names, comma separated list

Path Parameters

Parameter Description
{{search_towns}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "search_results": {
      "1": {
        "property_name": "Fawlty Towers",
        "property_street": "Asheldon Rd",
        "property_town": "Torquay",
        "property_postcode": "TQ1 2QS",
        "property_region": "Devon",
        "property_region_id": "1113",
        "property_country": "United Kingdom",
        "property_country_code": "GB",
        "property_tel": "34693544145",
        "property_email": "your@email.com",
        "stars": 3,
        "cat_id": 1,
        "images": [
          [
            {
              "large": "/bookyflow/uploadedimages/1/property/0/alpha.png",
              "medium": "/bookyflow/uploadedimages/1/property/0/medium/alpha.png",
              "small": "/bookyflow/uploadedimages/1/property/0/thumbnail/alpha.png"
            },
            {
              "small": "/bookyflow/uploadedimages/1/property/0/thumbnail/carryon_brexit_team.jpg",
              "medium": "/bookyflow/uploadedimages/1/property/0/medium/carryon_brexit_team.jpg",
              "large": "/bookyflow/uploadedimages/1/property/0/carryon_brexit_team.jpg"
            },
            {
              "medium": "/bookyflow/uploadedimages/1/property/0/medium/daily_cunts___.png",
              "large": "/bookyflow/uploadedimages/1/property/0/daily_cunts___.png",
              "small": "/bookyflow/uploadedimages/1/property/0/thumbnail/daily_cunts___.png"
            }
          ]
        ],
        "property_details_page": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=viewproperty&property_uid=1",
        "bookthis_link": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=dobooking&selectedProperty=1",
        "bookthis_text": "Book now!"
      },
      "3": {
  ...
  (Response truncated for brevity)
}

Search by regions

Endpoint

GET https://yourdomain.com/bookyflow/api/search/regions/{{search_regions}}

Path Parameters

Parameter Description
{{search_regions}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "search_results": {
      "1": {
        "property_name": "Fawlty Towers",
        "property_street": "Asheldon Rd",
        "property_town": "Torquay",
        "property_postcode": "TQ1 2QS",
        "property_region": "Devon",
        "property_region_id": "1113",
        "property_country": "United Kingdom",
        "property_country_code": "GB",
        "property_tel": "34693544145",
        "property_email": "your@email.com",
        "stars": 3,
        "cat_id": 1,
        "images": [
          [
            {
              "large": "/bookyflow/uploadedimages/1/property/0/alpha.png",
              "medium": "/bookyflow/uploadedimages/1/property/0/medium/alpha.png",
              "small": "/bookyflow/uploadedimages/1/property/0/thumbnail/alpha.png"
            },
            {
              "small": "/bookyflow/uploadedimages/1/property/0/thumbnail/carryon_brexit_team.jpg",
              "medium": "/bookyflow/uploadedimages/1/property/0/medium/carryon_brexit_team.jpg",
              "large": "/bookyflow/uploadedimages/1/property/0/carryon_brexit_team.jpg"
            },
            {
              "medium": "/bookyflow/uploadedimages/1/property/0/medium/daily_cunts___.png",
              "large": "/bookyflow/uploadedimages/1/property/0/daily_cunts___.png",
              "small": "/bookyflow/uploadedimages/1/property/0/thumbnail/daily_cunts___.png"
            }
          ]
        ],
        "property_details_page": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=viewproperty&property_uid=1",
        "bookthis_link": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=dobooking&selectedProperty=1",
        "bookthis_text": "Book now!"
      },
      "7": {
  ...
  (Response truncated for brevity)
}

Search by countries

Endpoint

GET https://yourdomain.com/bookyflow/api/search/countries/NL,RO

Response Example

Status: OK (200)

{
  "data": {
    "search_results": {
      "17": {
        "property_name": "Jaguar XJ",
        "property_street": "33 some street",
        "property_town": "Brasov",
        "property_postcode": "500073",
        "property_region": "Brasov",
        "property_region_id": "3081",
        "property_country": "United Kingdom",
        "property_country_code": "RO",
        "property_tel": "3483596032650",
        "property_email": "your@email.com",
        "stars": 0,
        "cat_id": 0,
        "images": [
          [
            {
              "large": "/bookyflow/uploadedimages/17/property/0/5.jpg",
              "medium": "/bookyflow/uploadedimages/17/property/0/medium/5.jpg",
              "small": "/bookyflow/uploadedimages/17/property/0/thumbnail/5.jpg"
            }
          ]
        ],
        "property_details_page": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=viewproperty&property_uid=17",
        "bookthis_link": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=dobooking&selectedProperty=17",
        "bookthis_text": "Book now!"
      },
      "18": {
        "property_name": "Rolls Royce Phantom",
        "property_street": "44 some street",
        "property_town": "Brasov",
        "property_postcode": "500772",
        "property_region": "Brasov",
        "property_region_id": "3081",
        "property_country": "United Kingdom",
        "property_country_code": "RO",
        "property_tel": "423432423432",
        "property_email": "your@email.com",
  ...
  (Response truncated for brevity)
}