curl --request POST \
--url https://data.apartmentiq.io/apartmentiq/api/v2/stakeholder_entities/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "{account_id}"
}
'{
"rows": [
{
"organization_name": "Greystar Real Estate Partners",
"entity_type": "Property Manager",
"domain_name": "greystar.com",
"employee_count_range": "1001-5000",
"linkedin_url": "https://www.linkedin.com/company/greystar/",
"website_url": "https://www.greystar.com",
"phone_number": "+1-800-555-0100",
"stakeholder_entity_id": 123,
"company_entity_type": "company",
"company_legal_type": "private",
"year_founded": "1993",
"description": "A global real estate organization.",
"image_url": "https://cdn.example.com/organizations/greystar.png",
"headquarters_city": "Charleston",
"headquarters_address": "465 Meeting Street",
"headquarters_state": "SC",
"headquarters_zip_code": "29403",
"headquarters_country": "US",
"rent": 1501.24,
"property_count": 80,
"unit_count": 14500,
"market_count": 12
}
],
"pagination": {
"current_page": 1,
"total_pages": 4,
"total_count": 80,
"per_page": 25
}
}Bulk
Bulk Organizations
Retrieve bulk organization rows using optional organization and property filters, requested fields, and pagination.
Count fields use the latest indexed property data. The collected_at_gte and collected_at_lte filters do not change these values. If you request an interval, each interval row contains the same current count values.
Requires Explore Pro Plus access.
POST
/
stakeholder_entities
/
bulk
curl --request POST \
--url https://data.apartmentiq.io/apartmentiq/api/v2/stakeholder_entities/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "{account_id}"
}
'{
"rows": [
{
"organization_name": "Greystar Real Estate Partners",
"entity_type": "Property Manager",
"domain_name": "greystar.com",
"employee_count_range": "1001-5000",
"linkedin_url": "https://www.linkedin.com/company/greystar/",
"website_url": "https://www.greystar.com",
"phone_number": "+1-800-555-0100",
"stakeholder_entity_id": 123,
"company_entity_type": "company",
"company_legal_type": "private",
"year_founded": "1993",
"description": "A global real estate organization.",
"image_url": "https://cdn.example.com/organizations/greystar.png",
"headquarters_city": "Charleston",
"headquarters_address": "465 Meeting Street",
"headquarters_state": "SC",
"headquarters_zip_code": "29403",
"headquarters_country": "US",
"rent": 1501.24,
"property_count": 80,
"unit_count": 14500,
"market_count": 12
}
],
"pagination": {
"current_page": 1,
"total_pages": 4,
"total_count": 80,
"per_page": 25
}
}Authorizations
Body
application/json
Request contract for the API V2 organizations bulk export endpoint.
Optional property metric and current portfolio count fields. Omit or pass an empty array for identity-only rows.
Property metric field to include in each bulk 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 Response
Bulk organization rows and pagination metadata.
Paginated organization bulk export results.