Sign in

v1

latestOpenAPI 3.0.02026-07-26190104.7 KB
Listings

Get a specific listing

This call returns a listing by ID

get/api/listings/{listingId}

Path parameters

listingIdstring required
Example:5d6e7a7ebf8e3800207735ae

ID of listing

Query parameters

fieldsstring
Example:_id address.city title accommodates

The list of the listing fields to return separated by spaces. The fields should be taken from Listing object definition. To include bed arrangements to a response, please add bedArrangements to the fields in query params.

Response

successful operation

Example response

{
  "results": {
    "prices": {
      "basePrice": 1
    },
    "bedArrangements": {
      "bedrooms": [
        {
          "roomNumber": 1,
          "beds": {
            "KING_BED": 1,
            "QUEEN_BED": 1,
            "DOUBLE_BED": 1,
            "SINGLE_BED": 1,
            "SOFA_BED": 1,
            "AIR_MATTRESS": 1,
            "BUNK_BED": 1,
            "FLOOR_MATTRESS": 1,
            "WATER_BED": 1,
            "TODDLER_BED": 1,
            "CRIB": 1
          }
        }
      ],
      "bathrooms": {
        "BEDROOM": 1,
        "PRIVATE": 1
      }
    }
  }
}