Properties API

Design

The Properties API lets you retrieve a raft of data about a Property on Staylists. It’s perhaps useful after using the Glimpses API to ascertain whether or not we have a given property.

Authentication

This request requires authentication

Request

Make a GET request to the following endpoint, replacing {id} with the Staylist property ID you wish to retrieve:

https://app.staylists.com/api/v3/properties/{id}

Response

Providing the Property exists, you should get a response that looks a little like this:

{
    "object": "BookableOwner",
    "data": {
        "id": 1454,
        "name": "The Riverboat Inn",
        "subdomain": "theriverboatinn",
        "uuid": "55ebf440-65cc-48c4-b13e-40d229837848",
        "address": {
            "address_line_1": "Double Street",
            "address_line_2": "",
            "town": "Waldringfield",
            "county": "Suffolk",
            "country_code": "GB",
            "latitude": "52.0525582",
            "longitude": "1.3315666"
        },
        "bookables": [
            {
                "id": 6479,
                "name": "Folly",
                "uuid": "3773cb2e-7da6-445b-9c7d-a06ef6af9d0b",
                "units_count": 1,
                "occupancy_max": 3,
                "occupancy": {
                    "adults": 2,
                    "children": 1,
                    "infants": 0,
                    "dogs": 0
                }
            },
            {
                "id": 6480,
                "name": "Primrose",
                "uuid": "04d476c3-13d7-4b48-8cd1-744f7afbcee1",
                "units_count": 1,
                "occupancy_max": 3,
                "occupancy": {
                    "adults": 2,
                    "children": 1,
                    "infants": 1,
                    "dogs": 0
                }
            }
        ],
        "rate_types": [
            {
                "id": 1679,
                "name": "Bed & Breakfast",
                "uuid": "fd96597f-ded0-4e21-9126-f9e388464408"
            },
            {
                "id": 52389,
                "name": "New Year's Eve Package",
                "uuid": "fb461f79-a519-4299-9916-3bfe2a0cd29e"
            }
        ],
        "photos": [
            {
                "url": "https://d1bz4kuoetuc8l.cloudfront.net/uploads/photo/file/9807/primrose.png"
            },
            {
                "url": "https://d1bz4kuoetuc8l.cloudfront.net/uploads/photo/file/9812/folly.png"
            }
        ]
    }
}