Retrieve an overview of the buildings owned by an organization

GET 
/companies/building-overview

Organization Building Overview Endpoint

Overview

This API returns an overview of all buildings associated with a given organization, based on its organization number.

It looks up the properties owned by the organization and returns the buildings on those properties, including their building IDs, building numbers, property ID NMAs, and UFS totals. The response can be filtered using the include-building-ids, include-building-numbers, include-property-id-nmas, and include-ufs-totals query parameters to control which fields are included.

The endpoint supports the following query parameters:

• organization-number: The organization number of the company to fetch building data for. / Organisasjonsnummeret til selskapet man ønsker bygningsdata for.
• include-building-ids: Whether to include building IDs in the response. / Om bygnings-ID-er skal inkluderes i responsen.
• include-building-numbers: Whether to include building numbers in the response. / Om bygningsnumre skal inkluderes i responsen.
• include-property-id-nmas: Whether to include property ID NMAs in the response. / Om eiendoms-ID NMA-er skal inkluderes i responsen.
• include-ufs-totals: Whether to include UFS totals in the response. / Om totalt bruksareal skal inkluderes i responsen.

Example Request

curl -X 'GET' \
  'https://apis.propcloud.no/api/public/companies/building-overview?organization-number=810547472' \
  -H 'accept: application/json' \
  -H 'api-key: YOUR_API_KEY'

Response Description

Key	Description	Beskrivelse	Source
organizationNumber	Unique identifier for the organization	Unik identifikator for organisasjonen	PropCloud
buildingCount	The total number of buildings associated with the organization	Totalt antall bygninger tilknyttet organisasjonen	PropCloud
buildings	List of buildings associated with the organization	Liste over bygninger tilknyttet organisasjonen	PropCloud
buildings[].buildingId	Unique identifier for the building. Additions / changes to a building gets a unique building ID but keeps the same building number	Unik identifikator for bygningen. Paabygg / endringer paa bygning faar eget bygningsid, men beholder samme bygningsnummer	Kartverket
buildings[].buildingNumber	Unique identifier for the building. Building number assigned to the building.	Unik identifikator for bygningen. Feltet heter bygningsnummer i Matrikkelen	Kartverket
buildings[].propertyIdNma	Unique identifier for the property, generated by PropCloud based on: city number, ground number, usage number, lease number, and section number	Unik identifikator for eiendommen generert av PropCloud basert paa: kommunenummer, gaardsnummer, bruksnummer, festenummer og seksjonsnummer	PropCloud
buildings[].ufsTotal	Total usable floor space in square meters.	Totalt bruksareal i kvadratmeter.	Kartverket
meta	Meta information about the response, reflecting which fields were requested	Metainformasjon om responsen som viser hvilke felter som ble forespurt	PropCloud
meta.includeBuildingIds	Whether building IDs are included in the response	Om bygnings-ID-er er inkludert i responsen	PropCloud
meta.includeBuildingNumbers	Whether building numbers are included in the response	Om bygningsnumre er inkludert i responsen	PropCloud
meta.includePropertyIdNmas	Whether property ID NMAs are included in the response	Om eiendoms-ID NMA-er er inkludert i responsen	PropCloud
meta.includeUfsTotals	Whether UFS totals are included in the response	Om totalt bruksareal er inkludert i responsen	PropCloud

Request

Responses

200

Successful Response

422

Validation Error