Read Property

GET

https://api.fortresstech.io/v1/properties/:propertyId

GET

/v1/properties/:propertyId

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

200Retrieved

{
  "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",
  "units": [
    {
      "number": "string",
      "floorLevel": "string",
      "isADA": true,
      "streetAddress1": "string",
      "streetAddress2": "string",
      "city": "string",
      "state": "string",
      "zipCode": "string",
      "fullAddress": "string",
      "status": "VACANT_READY",
      "isOccupied": true,
      "floorPlanId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "buildingId": "string",
      "currentHouseholdId": "string",
      "lastMoveOutId": "string",
      "priorLeaseId": "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",
      "vacantSince": "2024-01-15T09:30:00Z",
      "reportOrder": 1.1,
      "makeReadyDate": "2023-01-15",
      "reportConfigurationValue": "Quoting Rent",
      "lastVacancyStartDate": "2023-01-15",
      "mostRecentApplicationId": "string"
    }
  ],
  "attachments": [
    {
      "name": "string",
      "url": "string",
      "type": "ISSUE",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "workOrderId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "notes": "string",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "deletedAt": "2024-01-15T09:30:00Z",
      "householdId": "string",
      "customerId": "string"
    }
  ],
  "workOrders": [
    {
      "status": "OPEN",
      "priority": "LOW",
      "hasPetAlert": true,
      "completedAt": "2024-01-15T09:30:00Z",
      "requestorPhone": "string",
      "requestorEmail": "string",
      "requestedStartDateFrom": "2023-01-15",
      "requestedStartDateTo": "2023-01-15",
      "requestedStartTimeFrom": "string",
      "requestedStartTimeTo": "string",
      "dueDate": "2023-01-15",
      "description": "string",
      "serviceNotes": "string",
      "vendorNotes": "string",
      "entryNotes": "string",
      "entryPreference": "24_HOUR_NOTICE",
      "isDoorCodeActive": true,
      "isAlarmActive": true,
      "doorCode": "string",
      "alarmCode": "string",
      "holdReason": "string",
      "otherLocationDetail": "string",
      "attachmentIds": "string",
      "technicianNotes": "string",
      "previouslyReported": true,
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "string",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "assignedUserId": "string",
      "householdId": "string",
      "customerId": "string",
      "unitId": "string",
      "maintenanceIssueId": "string",
      "maintenanceLocationId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "totalCostOfMaterialsUsed": 1.1,
      "totalAmountOwedByResident": 1.1,
      "totalAmountOwedByProperty": 1.1,
      "hourlyServiceRate": 1.1,
      "totalLaborCost": 1.1
    }
  ],
  "households": [
    {
      "status": "APPLICANT",
      "isUnderEviction": true,
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "currentUnitId": "string",
      "currentLeaseId": "string",
      "applicationId": "string",
      "organizationId": "string",
      "propertyId": "string",
      "currentCertificationId": "string",
      "prospectId": "string",
      "primaryCustomerId": "string",
      "totalActiveRentAmount": 1.1,
      "totalActiveSubsidyAmount": 1.1,
      "totalActiveFeesAmount": 1.1,
      "unitId": "string"
    }
  ],
  "amenities": [
    {
      "name": "string",
      "code": "string",
      "startDate": "2024-01-15T09:30:00Z",
      "endDate": "2024-01-15T09:30:00Z",
      "type": "UNIT",
      "feeAmount": 1.1,
      "includedInMarketRent": true,
      "propertyId": "string",
      "unitId": "string",
      "floorPlanId": "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"
    }
  ],
  "configuration": {
    "propertyDescription": "string",
    "shortDescription": "string",
    "officeHoursDescription": "string",
    "officeHours": "string",
    "petPolicyDescription": "string",
    "parkingDetailDescription": "string",
    "amenities": "string",
    "marketingUrl": "string",
    "email": "string",
    "phone": "string",
    "faxNumber": "string",
    "textingPhoneNumber": "string",
    "physicalStreetAddress1": "string",
    "physicalStreetAddress2": "string",
    "physicalCity": "string",
    "physicalState": "string",
    "physicalZip": "string",
    "physicalCountry": "string",
    "applicationPortalUrl": "string",
    "availabilityUrl": "string",
    "lateFeeMethod": "string",
    "acceptingOnlineApplications": true,
    "applicationIncomeRequirement": "string",
    "allowedLeaseTermMonths": "string",
    "quoteExpiration": "SAME_DAY",
    "masterMeteredElectricity": true,
    "masterMeteredGas": true,
    "masterMeteredSewer": true,
    "masterMeteredTrash": true,
    "masterMeteredWater": true,
    "masterMeteredOther": "string",
    "accrueSecurityDepositInterest": true,
    "securityDepositInterestPayoutFrequency": "Monthly",
    "securityDepositSimpleInterestRate": 1.1,
    "nearestMetroArea": "string",
    "timezone": "string",
    "goesOnDaylightSavings": true,
    "countyName": "string",
    "siteBuiltDate": "string",
    "lastRenovationDate": "string",
    "managementTookOverDate": "2024-01-15T09:30:00Z",
    "acquisitionDate": "2024-01-15T09:30:00Z",
    "managementQuitDate": "2024-01-15T09:30:00Z",
    "officeAlarmCode": "string",
    "hasGateWithCode": true,
    "clientRepresentativeName": "string",
    "accountantName": "string",
    "apClerk": "string",
    "turnMoveOutDays": 1,
    "evictionStartDate": "string",
    "leaseNoticeToVacateDays": "string",
    "emergencyEntranceNotice": "string",
    "hasFitnessCenter": true,
    "hasPool": true,
    "hasPackageDelivery": true,
    "nonSmoking": true,
    "petWeightMax": "string",
    "leadPaintDisclosure": "string",
    "waterCompany": "string",
    "gasCompany": "string",
    "electricCompany": "string",
    "cableCompany": "string",
    "internetCompany": "string",
    "pestCompany": "string",
    "trashCompany": "string",
    "feesStartDate": "2024-01-15T09:30:00Z",
    "currentPeriodStartDate": "2024-01-15T09:30:00Z",
    "currentPeriod": "string",
    "buildingProtectionFee": "Building Protection Fee",
    "leaseRentPercentage": "string",
    "chargesFacilityFeeForLiabilityInsurance": true,
    "facilitiesFeeAmount": 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"
  },
  "applications": [
    {
      "notes": "string",
      "status": "APPROVED",
      "submittedAt": "2024-01-15T09:30:00Z",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "primaryFormCompletedAt": "2024-01-15T09:30:00Z",
      "secondaryFormCompletedAt": "2024-01-15T09:30:00Z",
      "assignedUserId": "string",
      "assignedUnitId": "string",
      "householdId": "string",
      "leaseId": "string",
      "applicantId": "string",
      "organizationId": "string",
      "propertyId": "string"
    }
  ],
  "deposits": [
    {
      "total": 1.1,
      "fiscalPeriod": "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",
      "propertyId": "string",
      "organizationId": "string"
    }
  ],
  "documents": [
    {
      "url": "string",
      "id": "string",
      "householdId": "string",
      "propertyId": "string",
      "name": "string",
      "type": "string",
      "mimeType": "string",
      "notes": "string",
      "isReviewed": false,
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "organizationId": "string",
      "createdByUserId": "string"
    }
  ],
  "floorPlans": [
    {
      "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"
    }
  ],
  "glEntries": [
    {
      "amount": 1.1,
      "note": "string",
      "date": "2024-01-15T09:30:00Z",
      "creditAmount": 1.1,
      "debitAmount": 1.1,
      "accountNumber": "string",
      "fiscalPeriod": "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",
      "householdId": "string",
      "customerId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "transactionId": "string"
    }
  ],
  "listings": [
    {
      "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"
    }
  ],
  "maintenanceIssues": [
    {
      "description": "string",
      "type": "UNIT",
      "id": "string",
      "organizationIssueId": "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",
      "categoryId": "string",
      "maintenanceLocationId": "string"
    }
  ],
  "maintenanceLocations": [
    {
      "name": "string",
      "type": "UNIT",
      "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"
    }
  ],
  "moveIns": [
    {
      "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"
    }
  ],
  "moveOuts": [
    {
      "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"
    }
  ],
  "prospects": [
    {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "string",
      "referralSource": "string",
      "propertyId": "string",
      "organizationId": "string",
      "assignedUserId": "string",
      "prospectStatusId": "string",
      "isPrimaryProspect": true,
      "portalInviteUrl": "string",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "rentableItems": [
    {
      "name": "string",
      "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"
    }
  ],
  "rentChanges": [
    {
      "startDate": "2023-01-15",
      "endDate": "2023-01-15",
      "note": "string",
      "rentAmount": 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",
      "leaseId": "string",
      "organizationId": "string",
      "propertyId": "string"
    }
  ],
  "reports": [
    {
      "reportId": "string",
      "propertyId": "string",
      "filter": "string",
      "fields": "string",
      "sort": "string",
      "requestedBy": "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",
      "organizationId": "string"
    }
  ],
  "scheduledTransactions": [
    {
      "amount": 1.1,
      "type": "PAYMENT",
      "code": "string",
      "ledger": "OPERATING",
      "subledger": "RESIDENT",
      "startDate": "2023-01-15",
      "endDate": "2023-01-15",
      "description": "string",
      "notes": "string",
      "frequency": "DAILY",
      "note": "string",
      "id": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "organizationId": "string",
      "leaseId": "string",
      "householdId": "string",
      "propertyId": "string"
    }
  ],
  "transactions": [
    {
      "id": "string",
      "readableId": "string",
      "customerId": "string",
      "householdId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "depositId": "string",
      "date": "2024-01-15T09:30:00Z",
      "amount": 1.1,
      "note": "string",
      "code": "string",
      "subjournal": "RESIDENT",
      "ledger": "RESIDENT",
      "fiscalPeriod": "string",
      "isPaid": true,
      "type": "CREDIT",
      "reversedTransactionId": "string",
      "runningBalanceAmount": 1.1,
      "paymentDate": "2024-01-15T09:30:00Z",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "unitStatusChanges": [
    {
      "status": "VACANT_READY",
      "statusDate": "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",
      "unitId": "string",
      "propertyId": "string",
      "organizationId": "string"
    }
  ],
  "customers": [
    {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "preferredName": "string",
      "suffix": "string",
      "birthDate": "2023-01-15",
      "status": "APPLICANT",
      "email": "string",
      "phone": "string",
      "gender": "string",
      "headOfHousehold": true,
      "relationship": "PARTNER",
      "passportNumberLastFour": "string",
      "passportCountry": "string",
      "alienRegistrationNumberLastFour": "string",
      "citizenshipStatus": "string",
      "maritalStatus": "string",
      "spouseName": "string",
      "studentType": "string",
      "currentAddressStreet": "string",
      "currentAddressStreet2": "string",
      "currentAddressCity": "string",
      "currentAddressState": "string",
      "currentAddressZipCode": "string",
      "lenderName": "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",
      "householdId": "string",
      "propertyId": "string",
      "organizationId": "string"
    }
  ],
  "activities": [
    {
      "notes": "string",
      "type": "EMAILED",
      "prospectId": "string",
      "assignedUserId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "householdId": "string",
      "customerStatus": "string",
      "startTime": "2024-01-15T09:30:00Z",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "userProperties": [
    {
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "userId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ]
}

Info for a specific property

Authentication

x-api-keystring

API Key authentication via header

Path parameters

propertyIdstringRequired

The id of the property

Response

Expected response to a valid request

namestringOptional

shortNamestringOptional

emailstringOptional<=50 characters

phonestringOptional

physicalStreetAddress1stringOptional

physicalStreetAddress2stringOptional

physicalCitystringOptional

physicalStatestringOptional

physicalZipstringOptional

physicalCountrystringOptional

mailingStreetAddress1stringOptional

mailingStreetAddress2stringOptional

mailingCitystringOptional

mailingStatestringOptional

mailingZipstringOptional

mailingCountrystringOptional

phoneNumberstringOptional

faxNumberstringOptional

timezonestringOptional

longitudedoubleOptional

latitudedoubleOptional

turnMoveOutDaysintegerOptional

Number of days after move-out to calculate make ready date

statusenum or nullOptional

Property lifecycle status. Fortress aggregates occupancy only for ACTIVE properties.

Allowed values:

propertyClassenum or nullOptional

The property's class. Null for properties with no class assigned.

Allowed values:

organizationIdstringOptionalformat: "uuid"

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

offboardedAtdatetimeOptional

countyNamestringOptional

acquisitionDatedatetimeOptional

unitslist of objectsOptional

attachmentslist of objectsOptional

workOrderslist of objectsOptional

householdslist of objectsOptional

amenitieslist of objectsOptional

configurationobjectOptional

applicationslist of objectsOptional

depositslist of objectsOptional

documentslist of objectsOptional

floorPlanslist of objectsOptional

glEntrieslist of objectsOptional

listingslist of objectsOptional

maintenanceIssueslist of objectsOptional

maintenanceLocationslist of objectsOptional

moveInslist of objectsOptional

moveOutslist of objectsOptional

prospectslist of objectsOptional

rentableItemslist of objectsOptional

rentChangeslist of objectsOptional

reportslist of objectsOptional

scheduledTransactionslist of objectsOptional

transactionslist of objectsOptional

unitStatusChangeslist of objectsOptional

customerslist of objectsOptional

activitieslist of objectsOptional

userPropertieslist of objectsOptional