API ReferenceWork Orders

List Work Orders

List all Work Orders

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.
sortstringOptionalformat: "^([a-zA-Z]+(:(asc|desc)+)?,?)+$"

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0
the page number when used with pagination, defaults to 0
limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

Response

A paged array of work orders
alarmCodestring or null
assignedUserIdstring or nullformat: "uuid"
attachmentIdsstring or nullformat: "uuid"
attachmentslist of objects or null
completedAtdatetime or null
createdAtstring or null
customerobject or null
customerIdstring or nullformat: "uuid"
deletedAtdatetime or null
descriptionstring or null<=500 characters
doorCodestring or null
dueDatestring or nullformat: "date"
entryNotesstring or null<=500 characters
entryPreferenceenum or null
Allowed values:
hasPetAlertboolean or null
holdReasonstring or null
hourlyServiceRatedouble or null
The hourly service rate.
householdobject or null
householdIdstring or nullformat: "uuid"
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
isAlarmActiveboolean or null
isDoorCodeActiveboolean or null
maintenanceIssueobject or null
maintenanceIssueIdstring or nullformat: "uuid"
maintenanceLocationobject or null
maintenanceLocationIdstring or nullformat: "uuid"
organizationIdstring or nullformat: "uuid"
otherLocationDetailstring or null<=500 characters
previouslyReportedboolean or null
If the Issue was previously reported, this will be true.
priorityenum or null
Allowed values:
propertyobject or null
propertyIdstring or nullformat: "uuid"
readableIdstring or null
requestedStartDateFromstring or nullformat: "date"
requestedStartDateTostring or nullformat: "date"
requestedStartTimeFromstring or null
requestedStartTimeTostring or null
requestorEmailstring or null
requestorPhonestring or null
serviceNotesstring or null<=2000 characters
statusenum or null
Allowed values:
technicianNotesstring or null<=500 characters
Notes to the technician.
totalAmountOwedByPropertydouble or null
The total amount owed by the property.
totalAmountOwedByResidentdouble or null
The total amount owed by the resident.
totalCostOfMaterialsUseddouble or null
The total cost of materials used.
totalLaborCostdouble or null
The total labor cost.
unitobject or null
unitIdstring or nullformat: "uuid"
updatedAtdatetime or null
userobject or null
vendorNotesstring or null<=2000 characters