Skip to main content
POST
Bulk Properties

Authorizations

Authorization
string
header
required

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

Body

application/json

Request contract for the API V2 properties bulk export endpoint.

account_id
required

ApartmentIQ account ID used to set the request account context.

interval
enum<string>

Optional period bucket for requested metrics. Omit for one summary row per property.

Available options:
month,
quarter,
year
fields
enum<string>[]

Optional metric field names. Omit or pass an empty array for identity-only rows.

Metric field to include in each property row.

Available options:
rent,
rent_0_bed,
rent_1_bed,
rent_2_bed,
rent_3_bed,
ner,
ner_0_bed,
ner_1_bed,
ner_2_bed,
ner_3_bed,
rent_psf,
rent_0_bed_psf,
rent_1_bed_psf,
rent_2_bed_psf,
rent_3_bed_psf,
ner_psf,
ner_0_bed_psf,
ner_1_bed_psf,
ner_2_bed_psf,
ner_3_bed_psf,
rent_growth_rate_yoy,
ner_growth_rate_yoy,
concession_value,
concession_percent,
days_on_market,
occupancy_percent,
leased_percent,
exposure_percent
property_filters
object

Filters used to select properties and constrain the metric aggregation date range.

page
integer
default:1

One-based page number for the export result set.

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

Number of rows per page. Values above the maximum are clamped.

Required range: 1 <= x <= 100

Response

Bulk property rows and pagination metadata.

Paginated property bulk export results.

rows
object[]
required

Property rows for the current page. Each row includes property identity fields and any requested metric fields.

pagination
object
required

Pagination details for the property bulk export rows.