List maintenance requests
Returns a page of the company's maintenance requests — what tenants and staff have reported as needing fixing, before any job is scheduled. Every filter below is optional and they combine. Requires the maintenance_requests:read permission.
Authorization
AuthorizationstringrequiredQuery parameters
pageintegerWhich page to return. Counting starts at 1.
pageSizeintegerHow many records to return per page. Between 1 and 100.
propertyIdstringOnly requests on this property.
unitIdstringOnly requests on this unit.
portfolioIdstringOnly requests in this portfolio.
tenantIdstringOnly requests filed by this tenant.
leaseIdstringOnly requests against this lease.
runBookIdstringOnly requests currently handled by this runbook.
statusenum<string>[]Only requests in these states. Repeat the parameter to pass more than one.
urgencyenum<string>Only requests at this urgency.
categoryIdstringOnly requests filed under this maintenance request category.
searchTextstringFree-text search across the request.
created.startstring · date-timeOnly requests filed on or after this moment.
created.endstring · date-timeOnly requests filed on or before this moment.
newbooleantrue narrows to requests that are not closed and were filed inside the company's recent-requests window. It tightens status and created.start rather than replacing them, so a wider created.start you send is pulled in to the window.
openbooleantrue drops closed requests. If you also send status, the closed value is removed from what you asked for.
Response
200 · One page of results.
itemsobject[]requiredThe requests on this page. This is the short row shape — call Get a maintenance request for the description, the files and the linked work order.
totalCountintegerrequiredHow many records match in total, across all pages.
totalPagesintegerrequiredHow many pages there are at this page size.
pageintegerrequiredThe page that was returned. Counting starts at 1.
pageSizeintegerrequiredHow many records were asked for per page.