List Attachments

GET

https://api.fortresstech.io/v1/workOrders/:workOrderId/attachments

GET

/v1/workOrders/:workOrderId/attachments

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

200Retrieved

{
  "name": "string",
  "url": "string",
  "type": "ISSUE",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "workOrderId": "string",
  "propertyId": "string",
  "organizationId": "string",
  "notes": "string",
  "id": "string",
  "readableId": "string",
  "idempotencyId": "string",
  "deletedAt": "2024-01-15T09:30:00Z",
  "householdId": "string",
  "customerId": "string",
  "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"
  },
  "customer": {
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "preferredName": "string",
    "suffix": "string",
    "birthDate": "2023-01-15",
    "status": "APPLICANT",
    "email": "string",
    "phone": "string",
    "gender": "string",
    "headOfHousehold": true,
    "relationship": "PARTNER",
    "passportNumberLastFour": "string",
    "passportCountry": "string",
    "alienRegistrationNumberLastFour": "string",
    "citizenshipStatus": "string",
    "maritalStatus": "string",
    "spouseName": "string",
    "studentType": "string",
    "currentAddressStreet": "string",
    "currentAddressStreet2": "string",
    "currentAddressCity": "string",
    "currentAddressState": "string",
    "currentAddressZipCode": "string",
    "lenderName": "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",
    "householdId": "string",
    "propertyId": "string",
    "organizationId": "string"
  },
  "workOrder": {
    "status": "OPEN",
    "priority": "LOW",
    "hasPetAlert": true,
    "completedAt": "2024-01-15T09:30:00Z",
    "requestorPhone": "string",
    "requestorEmail": "string",
    "requestedStartDateFrom": "2023-01-15",
    "requestedStartDateTo": "2023-01-15",
    "requestedStartTimeFrom": "string",
    "requestedStartTimeTo": "string",
    "dueDate": "2023-01-15",
    "description": "string",
    "serviceNotes": "string",
    "vendorNotes": "string",
    "entryNotes": "string",
    "entryPreference": "24_HOUR_NOTICE",
    "isDoorCodeActive": true,
    "isAlarmActive": true,
    "doorCode": "string",
    "alarmCode": "string",
    "holdReason": "string",
    "otherLocationDetail": "string",
    "attachmentIds": "string",
    "technicianNotes": "string",
    "previouslyReported": true,
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "string",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "assignedUserId": "string",
    "householdId": "string",
    "customerId": "string",
    "unitId": "string",
    "maintenanceIssueId": "string",
    "maintenanceLocationId": "string",
    "propertyId": "string",
    "organizationId": "string",
    "totalCostOfMaterialsUsed": 1.1,
    "totalAmountOwedByResident": 1.1,
    "totalAmountOwedByProperty": 1.1,
    "hourlyServiceRate": 1.1,
    "totalLaborCost": 1.1
  },
  "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"
  },
  "organization": {
    "id": "string",
    "name": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z"
  }
}

List all work orders documents

Authentication

x-api-keystring

API Key authentication via header

Path parameters

workOrderIdstringRequiredformat: "uuid"

The id of the work order

Response

A paged array of attachments

namestring

urlstring

Storage reference for the file. It is not fetchable. Request a short-lived link from GET /workOrders/{workOrderId}/attachments/{attachmentId}/downloadUrl.

typeenum

Allowed values:

createdAtdatetime

updatedAtdatetime

workOrderIdstringformat: "uuid"

propertyIdstringformat: "uuid"

organizationIdstringformat: "uuid"

notesstringOptional

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

deletedAtdatetimeOptional

householdIdstringOptionalformat: "uuid"

customerIdstringOptionalformat: "uuid"

householdobjectOptional

customerobjectOptional

workOrderobjectOptional

propertyobjectOptional

organizationobjectOptional