Read Listing

curl -G https://api.fortresstech.io/v1/listings/listingId \
     --data-urlencode fields=id,name,property.*,documents.type

{
  "number": "number",
  "amenityFeeAmt": 1.1,
  "building": {
    "name": "name",
    "numFloors": 1.1,
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "organizationId": "organizationId",
    "propertyId": "propertyId"
  },
  "buildingId": "buildingId",
  "createdAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "floorLevel": "floorLevel",
  "floorPlan": {
    "name": "name",
    "numBeds": 1,
    "numBaths": 1,
    "numHalfBaths": 1,
    "isAffordable": true,
    "isCommercial": true,
    "grossSqFt": 1200,
    "rentableSqFt": 1100,
    "marketingName": "marketingName",
    "marketingDesc": "marketingDesc",
    "baseMarketRentAmount": 1200.5,
    "quotingRentAmount": 1200.5,
    "financialMarketRentAmount": 1200.5,
    "hudGrossRent": 1.1,
    "grossRentLimit": 1.1,
    "maxRentPercent": 1.1,
    "utilityAllowancesSum": 1.1,
    "nonOptionalChargeSum": 1.1,
    "avgLeasedRent": 1.1,
    "propertyId": "propertyId",
    "organizationId": "organizationId",
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z"
  },
  "floorPlanId": "floorPlanId",
  "id": "id",
  "idempotencyId": "idempotencyId",
  "marketRentAmt": 1.1,
  "organizationId": "organizationId",
  "property": {
    "name": "name",
    "shortName": "shortName",
    "email": "email",
    "phone": "phone",
    "physicalStreetAddress1": "physicalStreetAddress1",
    "physicalStreetAddress2": "physicalStreetAddress2",
    "physicalCity": "physicalCity",
    "physicalState": "physicalState",
    "physicalZip": "physicalZip",
    "physicalCountry": "physicalCountry",
    "mailingStreetAddress1": "mailingStreetAddress1",
    "mailingStreetAddress2": "mailingStreetAddress2",
    "mailingCity": "mailingCity",
    "mailingState": "mailingState",
    "mailingZip": "mailingZip",
    "mailingCountry": "mailingCountry",
    "phoneNumber": "phoneNumber",
    "faxNumber": "faxNumber",
    "timezone": "timezone",
    "longitude": 1.1,
    "latitude": 1.1,
    "turnMoveOutDays": 1,
    "organizationId": "organizationId",
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "offboardedAt": "2024-01-15T09:30:00Z",
    "countyName": "countyName",
    "acquisitionDate": "2024-01-15T09:30:00Z"
  },
  "propertyId": "propertyId",
  "quotingRentAmt": 1.1,
  "readableId": "readableId",
  "scheduledMoveIn": {
    "scheduledDate": "scheduledDate",
    "actualDate": "actualDate",
    "status": "SCHEDULED",
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "organizationId": "organizationId",
    "propertyId": "propertyId",
    "unitId": "unitId",
    "householdId": "householdId",
    "leaseId": "leaseId"
  },
  "scheduledMoveOut": {
    "scheduledDate": "scheduledDate",
    "actualDate": "actualDate",
    "status": "SCHEDULED",
    "reason": "reason",
    "reasonType": "reasonType",
    "noticeDate": "noticeDate",
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "organizationId": "organizationId",
    "propertyId": "propertyId",
    "unitId": "unitId",
    "householdId": "householdId",
    "leaseId": "leaseId"
  },
  "status": "VACANT_READY",
  "updatedAt": "2024-01-15T09:30:00Z"
}

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

buildingobject

buildingIdstringformat: "uuid"

createdAtdatetime

deletedAtdatetime

floorLevelstring

floorPlanobject

floorPlanIdstring

idstringformat: "uuid"

idempotencyIdstringformat: "uuid"

marketRentAmtdouble

organizationIdstringformat: "uuid"

propertyobject

propertyIdstring

quotingRentAmtdouble

readableIdstring

scheduledMoveInobject

scheduledMoveOutobject

statusenum

updatedAtdatetime