Read Listing

GET

https://api.fortresstech.io/v1/listings/:listingId

GET

/v1/listings/:listingId

curl https://api.fortresstech.io/v1/listings/listingId \
     -H "x-api-key: <apiKey>"

200Retrieved

{
  "number": "string",
  "floorLevel": "string",
  "status": "VACANT_READY",
  "amenityFeeAmt": 1.1,
  "marketRentAmt": 1.1,
  "quotingRentAmt": 1.1,
  "scheduledMoveInId": "string",
  "scheduledMoveOutId": "string",
  "floorPlanId": "string",
  "propertyId": "string",
  "organizationId": "string",
  "buildingId": "string",
  "id": "string",
  "readableId": "string",
  "idempotencyId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "scheduledMoveIn": {
    "scheduledDate": "2023-01-15",
    "actualDate": "2023-01-15",
    "status": "SCHEDULED",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "organizationId": "string",
    "propertyId": "string",
    "unitId": "string",
    "householdId": "string",
    "leaseId": "string"
  },
  "scheduledMoveOut": {
    "scheduledDate": "2023-01-15",
    "actualDate": "2023-01-15",
    "status": "SCHEDULED",
    "reason": "string",
    "reasonType": "string",
    "noticeDate": "2023-01-15",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "organizationId": "string",
    "propertyId": "string",
    "unitId": "string",
    "householdId": "string",
    "leaseId": "string"
  },
  "floorPlan": {
    "name": "string",
    "numBeds": 1,
    "numBaths": 1,
    "numHalfBaths": 1,
    "isAffordable": true,
    "isCommercial": true,
    "grossSqFt": 1200,
    "rentableSqFt": 1100,
    "marketingName": "string",
    "marketingDesc": "string",
    "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": "string",
    "organizationId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z"
  },
  "property": {
    "name": "string",
    "shortName": "string",
    "email": "string",
    "phone": "string",
    "physicalStreetAddress1": "string",
    "physicalStreetAddress2": "string",
    "physicalCity": "string",
    "physicalState": "string",
    "physicalZip": "string",
    "physicalCountry": "string",
    "mailingStreetAddress1": "string",
    "mailingStreetAddress2": "string",
    "mailingCity": "string",
    "mailingState": "string",
    "mailingZip": "string",
    "mailingCountry": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "timezone": "string",
    "longitude": 1.1,
    "latitude": 1.1,
    "turnMoveOutDays": 1,
    "status": "ACTIVE",
    "propertyClass": "Conventional",
    "organizationId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "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": "string",
    "acquisitionDate": "2024-01-15T09:30:00Z"
  },
  "building": {
    "name": "string",
    "numFloors": 1.1,
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "organizationId": "string",
    "propertyId": "string"
  }
}

Info for a specific listing

Authentication

x-api-keystring

API Key authentication via header

Path parameters

listingIdstringRequired

The id of the listing

Query parameters

propertyIdstringOptional

The id of the property

Response

Expected response to a valid request

numberstring

floorLevelstringOptional

statusenumOptional

amenityFeeAmtfloatOptional

marketRentAmtfloatOptional

quotingRentAmtfloatOptional

scheduledMoveInIdstringOptionalformat: "uuid"

scheduledMoveOutIdstringOptionalformat: "uuid"

floorPlanIdstringOptionalformat: "uuid"

propertyIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

buildingIdstringOptionalformat: "uuid"

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

scheduledMoveInobjectOptional

scheduledMoveOutobjectOptional

floorPlanobjectOptional

propertyobjectOptional

buildingobjectOptional