API ReferenceListings

List Listings

List all available listings

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.
sortstringOptionalformat: "^([a-zA-Z]+(:(asc|desc)+)?,?)+$"

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0
the page number when used with pagination, defaults to 0
limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

formatenumOptionalDefaults to JSON
The format of the response
Allowed values:

Response

A paged array of prospects
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