GET residentapi/units/{unitId}/archmods?page={page}&pageSize={pageSize}&sort={sort}&status={status}
Gets all the arch mods for a unit
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| unitId |
(Required) |
integer |
Required |
| 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 |
| sort |
Available values to sort by: 'datesubmitted', 'fromto', 'status' |
string | |
| status |
Filter by the following string values: 'open' or 'closed' |
string |
Body Parameters
None.
Response Information
Resource Description
ListWrapperOfArchMod| Name | Description | Type | Additional information |
|---|---|---|---|
| Total | integer |
None. |
|
| Elements | Collection of ArchMod |
None. |
Response Formats
application/json, text/json
Sample:
{
"total": 1,
"elements": [
{
"archModId": 1,
"propertyId": 2,
"unitId": 1,
"residentId": 1,
"occupantName": "sample string 3",
"unitNumber": "sample string 4",
"status": "sample string 5",
"progressCode": "sample string 6",
"description": "sample string 7",
"notes": "sample string 8",
"dateSubmitted": "2025-12-24T09:15:53.1439993-05:00",
"startDate": "2025-12-24T09:15:53.1439993-05:00",
"endDate": "2025-12-24T09:15:53.1439993-05:00",
"categories": [
{
"id": 1,
"archModId": 2,
"archModCategoryId": 3,
"name": "sample string 4"
},
{
"id": 1,
"archModId": 2,
"archModCategoryId": 3,
"name": "sample string 4"
}
],
"attachments": [
{
"attachmentId": 1,
"archModId": 2,
"fileName": "sample string 3",
"fileUrl": "sample string 4"
},
{
"attachmentId": 1,
"archModId": 2,
"fileName": "sample string 3",
"fileUrl": "sample string 4"
}
]
},
{
"archModId": 1,
"propertyId": 2,
"unitId": 1,
"residentId": 1,
"occupantName": "sample string 3",
"unitNumber": "sample string 4",
"status": "sample string 5",
"progressCode": "sample string 6",
"description": "sample string 7",
"notes": "sample string 8",
"dateSubmitted": "2025-12-24T09:15:53.1439993-05:00",
"startDate": "2025-12-24T09:15:53.1439993-05:00",
"endDate": "2025-12-24T09:15:53.1439993-05:00",
"categories": [
{
"id": 1,
"archModId": 2,
"archModCategoryId": 3,
"name": "sample string 4"
},
{
"id": 1,
"archModId": 2,
"archModCategoryId": 3,
"name": "sample string 4"
}
],
"attachments": [
{
"attachmentId": 1,
"archModId": 2,
"fileName": "sample string 3",
"fileUrl": "sample string 4"
},
{
"attachmentId": 1,
"archModId": 2,
"fileName": "sample string 3",
"fileUrl": "sample string 4"
}
]
}
]
}