v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Housekeeping

getHousekeepers

Returns a list of housekeepers ### Group account support

get/getHousekeepers

Query parameters

propertyIDstring

ID for the properties to be queried (comma-separated, i.e. 37,345,89). It can be omitted if the API key is single-property, or to get results from all properties on an association.

pageNumberinteger

Results page number

pageSizeinteger

Results page size. Max = 1000

Response

200 Response

successboolean

Returns if the request could be completed

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.