Retrieve Information related to Housing Company Units

GET 
/companies/housing-company-units

Housing Company Units Endpoint

Overview

This API returns information about units (bruksenheter) tied to housing companies (boligselskap)

It supports fetching data for a single property, section, housing-association-unit or for a batch of housing association units.

The main purpose of this API is to list all units tied to a housing company and to provide a mapper between the housing company and the units it owns / manages.

Example Request

curl -X 'GET' \
  'https://apis.propcloud.no/api/public/companies/housing-company-units?property-id-nma-main=0301-210-56-0-0&org-id=913418719' \
  -H 'accept: application/json' \
  -H 'api-key: YOUR_API_KEY'

Response Description

Key	Description	Beskrivelse	Source
propertyId	Unique identifier for the property	Unik identifikator for eiendommen. Feltet heter MatrikkelenhetId i Matrikkelen	Kartverket
propertyIdNmaMain	If the object in question is a section or housing association unit, this field gives the main property the object is tied to	Hvis objektet er en seksjon eller borettslagsenhet, gir dette feltet hoved-eiendommen som objektet er knyttet til	PropCloud
propertyIdNmaSection	For sectioned properties Unique identifier for the property, generated by PropCloud based on: city number, ground number, usage number, lease number and section number	For seksjoner Unik identifikator for eiendommen generert av PropCloud basert paa: kommunenummer, gaardsnummer, bruksnummer, festenummer og seksjonsnummer	PropCloud
organizationNumber	Unique identifier for the organization	Unik identifikator for organisasjonen	Enhetsregisteret
batchId	Unique identifier for the batch	Unik identifikator for batchen	PropCloud
unitId	Unique identifier for the unit within the property	Unik identifikator for bruksenheten. Feltet heter BruksenhetId i Matrikkelen	Kartverket
housingAssociationId	Unique identifier for the housing association unit, formatted as organization number-share number, i.e. "924758716-4"	Unik identifikator for borettslagsandelen, formatert som organisasjonsnummer-andelsnummer, i.e. "924758716-4"	PropCloud
housingAssocationOrganizationId	Organization ID of the housing association.	Organisasjons-ID for borettslaget
housingAssociationShareNumber	The share number within the housing association.	Andelsnummeret i borettslaget	Finn.no
housingAssociationName	Name of the housing association.	Navn pa borettslaget	Finn.no
orgId	Unique identifier for the organization	Unik identifikator for organisasjonen	Enhetsregisteret

Request

Responses

200

Successful Response

422

Validation Error