Read Activity

GET

https://api.fortresstech.io/v1/activities/:activityId

GET

/v1/activities/:activityId

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

200Retrieved

{
  "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",
  "prospect": {
    "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"
  },
  "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"
  },
  "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"
  }
}

Info for a specific activity

Authentication

x-api-keystring

API Key authentication via header

Path parameters

activityIdstringRequired

Response

Expected response to a valid request

notesstringOptional

typeenumOptional

prospectIdstringOptionalformat: "uuid"

assignedUserIdstringOptionalformat: "uuid"

propertyIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

householdIdstringOptionalformat: "uuid"

customerStatusstringOptional

startTimedatetimeOptional

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

prospectobjectOptional

userobjectOptional

propertyobjectOptional

householdobjectOptional