List Leases

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

[
  {
    "claims": [
      {
        "balance": 1.1,
        "unitId": "unitId",
        "householdId": "householdId"
      }
    ],
    "createdAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "documentId": "documentId",
    "endDate": "endDate",
    "household": {
      "status": "APPLICANT",
      "isUnderEviction": true,
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "currentUnitId": "currentUnitId",
      "currentLeaseId": "currentLeaseId",
      "applicationId": "applicationId",
      "organizationId": "organizationId",
      "propertyId": "propertyId",
      "currentCertificationId": "currentCertificationId",
      "prospectId": "prospectId",
      "primaryCustomerId": "primaryCustomerId",
      "totalActiveRentAmount": 1.1,
      "totalActiveSubsidyAmount": 1.1,
      "totalActiveFeesAmount": 1.1,
      "unitId": "unitId"
    },
    "householdId": "householdId",
    "households": [
      {}
    ],
    "id": "id",
    "idempotencyId": "idempotencyId",
    "makeReadyDate": "makeReadyDate",
    "moveInDate": "moveInDate",
    "moveOut": {
      "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"
    },
    "moveOutDate": "moveOutDate",
    "moveOutId": "moveOutId",
    "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",
    "readableId": "readableId",
    "renewalOffers": [
      {}
    ],
    "rentAmount": 1.1,
    "rentChanges": [
      {}
    ],
    "scheduledtransactions": [
      {
        "amount": 1.1,
        "type": "PAYMENT",
        "code": "code"
      }
    ],
    "securityDepositAmount": 1.1,
    "startDate": "startDate",
    "turnMoveOutDays": 1,
    "unit": {
      "number": "number",
      "floorLevel": "floorLevel",
      "isADA": true,
      "status": "VACANT_READY",
      "floorPlanId": "floorPlanId",
      "propertyId": "propertyId",
      "organizationId": "organizationId",
      "buildingId": "buildingId",
      "currentHouseholdId": "currentHouseholdId",
      "lastMoveOutId": "lastMoveOutId",
      "priorLeaseId": "priorLeaseId",
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "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": "makeReadyDate",
      "reportConfigurationValue": "Quoting Rent",
      "lastVacancyStartDate": "lastVacancyStartDate",
      "mostRecentApplicationId": "mostRecentApplicationId"
    },
    "unitId": "unitId",
    "updatedAt": "2024-01-15T09:30:00Z"
  }
]

List all Leases

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)

Response

A paged array of leases

claimslist of objects

createdAtdatetime

deletedAtdatetime

documentIdstringformat: "uuid"

The id of the lease document

endDatestringformat: "date"

householdobject

householdIdstringformat: "uuid"

householdslist of objects

idstringformat: "uuid"

idempotencyIdstringformat: "uuid"

makeReadyDatestringformat: "date"

Unit make ready date from Unit table

moveInDatestringformat: "date"

Effective move-in date (actualMoveInDate if available, otherwise moveInDate)

moveOutobject

moveOutDatestringformat: "date"

Move-out date from the last NoticeToVacate

moveOutIdstringformat: "uuid"

organizationIdstringformat: "uuid"

propertyobject

propertyIdstringformat: "uuid"

readableIdstring

renewalOfferslist of objects

rentAmountdouble

rentChangeslist of objects

scheduledtransactionslist of objects

securityDepositAmountdouble

startDatestringformat: "date"

turnMoveOutDaysinteger

Turn move out days from Property table

unitobject

unitIdstringformat: "uuid"

updatedAtdatetime