API ReferenceListings

Read Listing

Info for a specific listing

Path parameters

listingIdstringRequired
The id of the listing

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.
propertyIdstringOptional
The id of the property

Response

Expected response to a valid request
numberstring
amenityFeeAmtdouble or null
buildingobject or null
buildingIdstring or nullformat: "uuid"
createdAtdatetime or null
deletedAtdatetime or null
floorLevelstring or null
floorPlanobject or null
floorPlanIdstring or null
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
marketRentAmtdouble or null
organizationIdstring or nullformat: "uuid"
propertyobject or null
propertyIdstring or null
quotingRentAmtdouble or null
readableIdstring or null
scheduledMoveInobject or null
scheduledMoveOutobject or null
statusenum or null
updatedAtdatetime or null