Fetch occupant history for a property on a given date

GET 
/properties/:property_id_nma/occupant-history

Property Occupant History Endpoint

Overview

This API returns all companies registered at a property on a given date, based on its property ID NMA.

Each entry represents a company that had its registered business address (forretningsadresse) at the property on the queried date, as derived from Enhetsregisteret and resolved to a property by PropCloud.

Results are paginated with a page size of 1000. Use the page query parameter (default: 1) to navigate pages.

Example Request

curl -X 'GET' \
  'https://apis.propcloud.no/api/public/properties/0301-210-37-0-0/occupant-history?as-of=2024-01-01&page=1' \
  -H 'accept: application/json' \
  -H 'api-key: YOUR_API_KEY'

Response Description

Key	Description	Beskrivelse	Source
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
asOf	The date for which occupants are queried (YYYY-MM-DD)	Datoen forespørselen gjelder for, i formatet YYYY-MM-DD	PropCloud
occupants	List of companies registered at the property on the given date	Liste over selskaper registrert på eiendommen på den angitte datoen	Enhetsregisteret
occupants[].orgNr	Organization number	Organisasjonsnummer	Enhetsregisteret
occupants[].orgName	Name of the organization	Navn på organisasjonen	Enhetsregisteret
occupants[].orgForm	Organization form code (e.g. AS, ENK)	Organisasjonsformkode (f.eks. AS, ENK)	Enhetsregisteret
occupants[].orgFormDescription	Human-readable description of the organization form	Lesbar beskrivelse av organisasjonsformen	Enhetsregisteret
occupants[].employeeCount	Number of registered employees at the start of the interval	Antall registrerte ansatte ved intervallets start	Enhetsregisteret
occupants[].businessAddress	Raw business address string as registered in Enhetsregisteret	Rå forretningsadresse slik den er registrert i Enhetsregisteret	Enhetsregisteret
occupants[].validFrom	Date when the company moved to this address (YYYY-MM-DD)	Dato da selskapet flyttet til denne adressen (YYYY-MM-DD)	Enhetsregisteret
occupants[].validTo	Date when the company left this address (YYYY-MM-DD), or null if still present. The company is not counted as present on this date itself	Dato da selskapet forlot denne adressen (YYYY-MM-DD), eller null hvis fortsatt tilstede. Selskapet regnes ikke som tilstede på denne datoen	Enhetsregisteret
occupants[].isLikelyInitialRegistrationAddress	true if this was likely the address used when the company was first registered; false if a later observed move confirms it was not; null if it cannot be determined (lower-bound start or missing registration date)	true hvis dette sannsynligvis var adressen ved første registrering; false hvis en senere observert flytting bekrefter at det ikke var det; null hvis det ikke kan fastslås	PropCloud
occupants[].validFromIsLowerBound	true if validFrom is an estimated lower bound rather than the exact move-in date	true hvis validFrom er et estimert nedre grense og ikke den eksakte innflyttingsdatoen	PropCloud
totalPages	The total number of pages of response for this specific query.	Totalt antall sider med respons for denne spesifikke forespørselen.	PropCloud

Request

Responses

200

Successful Response

422

Validation Error