Skip to main content
POST
List Organization Properties

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

stakeholder_entity_id
integer
required

ApartmentIQ stakeholder entity ID.

Body

application/json

Request contract for listing a stakeholder organization's properties.

account_id
required

ApartmentIQ account ID used to set the request account context.

property_filters
object

Optional property filters and metric aggregation date range. When stakeholder_entity_ids is provided, results are limited to properties associated with both the path stakeholder entity and the provided stakeholder entities.

page
integer
default:1

One-based page number. Values less than 1 are treated as 1.

Required range: x >= 1
per_page
integer
default:20

Rows per page. Values above 100 are capped at 100.

Required range: 1 <= x <= 100
sort_by
enum<string>
default:asking_rent_avg

Metric or property field used to sort results. Invalid values are treated as asking_rent_avg.

Available options:
unit_count,
year_built,
asking_rent_avg,
ner_avg,
asking_rent_psf_avg,
ner_psf_avg,
days_on_market_avg,
exposure_percent_avg,
occupancy_percent_avg,
leased_percent_avg,
concession_value_avg,
concession_percent_avg
sort_order
enum<string>
default:desc

Sort direction. Invalid values are treated as desc.

Available options:
asc,
desc

Response

Stakeholder organization properties and pagination metadata.

Paginated stakeholder organization property results.

properties
object[]
required

Properties associated with the stakeholder organization.

pagination
object
required

Pagination details for the property results.