Read Prospect

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

{
  "activities": [
    {
      "notes": "notes",
      "type": "EMAILED",
      "prospectId": "prospectId",
      "assignedUserId": "assignedUserId",
      "propertyId": "propertyId",
      "organizationId": "organizationId",
      "householdId": "householdId",
      "customerStatus": "customerStatus",
      "startTime": "2024-01-15T09:30:00Z",
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "assignedUser": {
    "firstName": "firstName",
    "lastName": "lastName",
    "email": "email",
    "username": "username",
    "status": "ACTIVE",
    "hasAllProperties": 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",
    "organizationId": "organizationId",
    "propertyIds": "propertyIds"
  },
  "assignedUserId": "assignedUserId",
  "createdAt": "2024-01-15T09:30:00Z",
  "email": "email",
  "firstName": "firstName",
  "households": [
    {
      "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"
    }
  ],
  "id": "id",
  "idempotencyId": "idempotencyId",
  "lastName": "lastName",
  "middleName": "middleName",
  "organizationId": "organizationId",
  "phone": "phone",
  "preferences": {
    "numBeds": 1,
    "numBaths": 1,
    "numHalfBaths": 1,
    "minPrice": 1,
    "maxPrice": 1,
    "leaseTerm": 1,
    "other": "other",
    "moveInStart": "2024-01-15T09:30:00Z",
    "moveInEnd": "2024-01-15T09:30:00Z"
  },
  "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",
  "referralSource": "referralSource",
  "updatedAt": "2024-01-15T09:30:00Z"
}

Info for a specific prospect

Path parameters

prospectIdstringRequired

The id of the prospect

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"

Specific fields requested in the response. Defaults to all fields.

Response

Expected response to a valid request

activitieslist of objects

assignedUserobject

assignedUserIdstringformat: "uuid"

createdAtdatetime

emailstring

firstNamestring

householdslist of objects

idstringformat: "uuid"

idempotencyIdstringformat: "uuid"

lastNamestring

middleNamestring

organizationIdstringformat: "uuid"

phonestring

preferencesobject

propertyobject

propertyIdstringformat: "uuid"

readableIdstring

referralSourcestring

updatedAtdatetime