GET residentapi/units/{unitId}/workorders?status={status}&sort={sort}&page={page}&pageSize={pageSize}

Gets the work orders for a unit

Request Information

URI Parameters

NameDescriptionTypeAdditional information
unitId

(Required)

integer

Required

status

'Open' or 'Closed'

string

sort

Can sort by the following string fields: 'submitted', 'type', 'category', 'status', 'number', 'progresscode'

string

page

The page number of returned records based on the page size

integer

0

pageSize

The number of records to return per page

integer

0

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfWorkorder
NameDescriptionTypeAdditional information
Total

integer

None.

Elements

Collection of Workorder

None.

Response Formats

application/json, text/json

Sample:
{
  "total": 1,
  "elements": [
    {
      "workOrderId": 1,
      "unitId": 1,
      "propertyId": 2,
      "createdOn": "2025-12-24T09:15:24.4877649-05:00",
      "status": "sample string 3",
      "type": "sample string 4",
      "typeId": 1,
      "category": {
        "categoryId": 1,
        "categoryName": "sample string 2"
      },
      "progressCode": "sample string 5",
      "progressCodeId": 1,
      "number": 6,
      "description": "sample string 7",
      "assignedTo": [
        "sample string 1",
        "sample string 2"
      ],
      "photos": [
        {
          "photoId": 1,
          "workorderId": 2,
          "name": "sample string 3",
          "caption": "sample string 4",
          "fileUrl": "sample string 5"
        },
        {
          "photoId": 1,
          "workorderId": 2,
          "name": "sample string 3",
          "caption": "sample string 4",
          "fileUrl": "sample string 5"
        }
      ],
      "phone": "sample string 8",
      "email": "sample string 9",
      "createdBy": 1,
      "submittedByName": "sample string 10",
      "unitsData": {
        "unitId": 1,
        "unitNumber": "sample string 2",
        "address1": "sample string 3",
        "address2": "sample string 4",
        "city": "sample string 5",
        "state": "sample string 6",
        "zip": "sample string 7"
      }
    },
    {
      "workOrderId": 1,
      "unitId": 1,
      "propertyId": 2,
      "createdOn": "2025-12-24T09:15:24.4877649-05:00",
      "status": "sample string 3",
      "type": "sample string 4",
      "typeId": 1,
      "category": {
        "categoryId": 1,
        "categoryName": "sample string 2"
      },
      "progressCode": "sample string 5",
      "progressCodeId": 1,
      "number": 6,
      "description": "sample string 7",
      "assignedTo": [
        "sample string 1",
        "sample string 2"
      ],
      "photos": [
        {
          "photoId": 1,
          "workorderId": 2,
          "name": "sample string 3",
          "caption": "sample string 4",
          "fileUrl": "sample string 5"
        },
        {
          "photoId": 1,
          "workorderId": 2,
          "name": "sample string 3",
          "caption": "sample string 4",
          "fileUrl": "sample string 5"
        }
      ],
      "phone": "sample string 8",
      "email": "sample string 9",
      "createdBy": 1,
      "submittedByName": "sample string 10",
      "unitsData": {
        "unitId": 1,
        "unitNumber": "sample string 2",
        "address1": "sample string 3",
        "address2": "sample string 4",
        "city": "sample string 5",
        "state": "sample string 6",
        "zip": "sample string 7"
      }
    }
  ]
}