List Renewal Offers

GET

https://api.fortresstech.io/v1/renewalOffers

GET

/v1/renewalOffers

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

200Retrieved

[
  {
    "offerDate": "2024-01-15T09:30:00Z",
    "expirationDate": "2024-01-15T09:30:00Z",
    "termMonths": 1,
    "rentAmount": 1.1,
    "masterLeaseTermId": "string",
    "termDescription": "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",
    "unitId": "string",
    "leaseId": "string",
    "organizationId": "string",
    "propertyId": "string",
    "unit": {
      "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"
    },
    "lease": {
      "startDate": "2023-01-15",
      "endDate": "2023-01-15",
      "moveInDate": "2023-01-15",
      "moveOutDate": "2023-01-15",
      "rentAmount": 1.1,
      "leasedRent": 1.1,
      "securityDepositAmount": 1.1,
      "makeReadyDate": "2023-01-15",
      "turnMoveOutDays": 1,
      "documentId": "string",
      "moveOutId": "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",
      "unitId": "string",
      "householdId": "string",
      "organizationId": "string"
    },
    "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"
    }
  }
]

List all renewal offers

Authentication

x-api-keystring

API Key authentication via header

Response

A paged array of renewal offers

offerDatedatetimeOptional

expirationDatedatetimeOptional

termMonthsintegerOptional

rentAmountdoubleOptional

masterLeaseTermIdstringOptionalformat: "uuid"

The id of the master lease term for the renewal offer

termDescriptionstringOptional

The description of the renewal lease term

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

unitIdstringOptionalformat: "uuid"

leaseIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

propertyIdstringOptionalformat: "uuid"

unitobjectOptional

leaseobjectOptional

propertyobjectOptional