List Applications

GET

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

GET

/v1/applications

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

200Retrieved

[
  {
    "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",
    "user": {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "username": "string",
      "status": "ACTIVE",
      "hasAllProperties": 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",
      "organizationId": "string",
      "propertyIds": "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"
    },
    "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"
    },
    "household": {
      "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"
    },
    "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"
    },
    "applicant": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string",
      "middleName": "string",
      "preferredName": "string",
      "status": "string",
      "email": "string",
      "phone": "string",
      "householdId": "string",
      "organizationId": "string",
      "propertyId": "string",
      "propertyName": "string",
      "applicantId": "string",
      "applicationId": "string",
      "residentId": "string",
      "unitId": "string",
      "unitNumber": "string",
      "order": 1,
      "source": "customer",
      "moveOutDate": "2023-01-15",
      "applicationStatus": "string",
      "personKey": "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"
    },
    "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"
      }
    ]
  }
]

List all applications

Authentication

x-api-keystring

API Key authentication via header

Query parameters

formatenumOptionalDefaults to JSON

The format of the response

Allowed values:

Response

A paged array of applications

notesstringOptional<=2000 characters

statusenumOptional

submittedAtdatetimeOptional

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

primaryFormCompletedAtdatetimeOptional

Timestamp of the last completed primary form for any applicant.

secondaryFormCompletedAtdatetimeOptional

Timestamp of the last completed secondary form for any applicant.

assignedUserIdstringOptionalformat: "uuid"

assignedUnitIdstringOptionalformat: "uuid"

householdIdstringOptionalformat: "uuid"

leaseIdstringOptionalformat: "uuid"

applicantIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

propertyIdstringOptionalformat: "uuid"

userobjectOptional

unitobjectOptional

propertyobjectOptional

householdobjectOptional

leaseobjectOptional

applicantobjectOptional

householdslist of objectsOptional