CLcloudbeds
Housekeeping

getHousekeepers

Returns a list of housekeepers ### Group account support

get/getHousekeepers

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/getHousekeepers
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: read:housekeeping

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.

Changes

No recorded changes to this operation across all 2 revisions of this API.