Skip to contents

Retrieves properties from the Entrata API.

Usage

get_properties(
  api,
  property_ids = NULL,
  property_lookup_codes = NULL,
  show_all_status = FALSE,
  ...
)

Arguments

api

An instance of the EntrataAPI class.

property_ids

A vector of property IDs to retrieve.

property_lookup_codes

A vector of property lookup codes to retrieve.

show_all_status

Logical. Whether to return all properties regardless of status.

...

Additional parameters to pass to the underlying API request.

Value

A data frame with the retrieved property information.