Skip to main content
GET
Get Organization Details

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.

Query Parameters

account_id
required

ApartmentIQ account ID used to set the request account context.

Response

Stakeholder organization details and portfolio summary metrics.

Stakeholder organization profile fields and portfolio summary metrics.

id
integer
required

ApartmentIQ stakeholder entity ID.

name
string
required

Display name for the stakeholder organization.

entity_type
string
required

Stakeholder entity type, such as Property Manager or Owner.

image_url
string | null
required

Logo or image URL for the organization, when available.

website_url
string | null
required

Organization website URL, when available.

domain_name
string | null
required

Organization domain name, when available.

linkedin_url
string | null
required

Organization LinkedIn URL, when available.

description
string | null
required

Organization description, when available.

company_entity_type
string | null
required

Company entity type, when available.

Company legal type, when available.

year_founded
string | null
required

Year the organization was founded, when available.

phone_number
string | null
required

Organization phone number, when available.

employee_count_range
string | null
required

Employee count range, when available.

headquarters_address
string | null
required

Headquarters street address, when available.

headquarters_city
string | null
required

Headquarters city, when available.

headquarters_state
string | null
required

Headquarters state, when available.

headquarters_zip_code
string | null
required

Headquarters postal code, when available.

headquarters_country
string | null
required

Headquarters country, when available.

property_count
integer
required

Count of associated properties.

total_unit_count
integer
required

Total unit count across associated properties.

units_by_market
object[]
required

Associated unit counts grouped by market.

units_by_property_class
object[]
required

Associated unit counts grouped by property class.

units_by_property_type
object[]
required

Associated unit counts grouped by property type.

market_rent_performance
object[]
required

Portfolio rent performance compared with each market.