Teknisk dokumentasjon

Her finner du forklaringer av feltene som returneres når du henter et enkelt byggeprosjekt.

GET /api/v2/project/{public_id}

Se API-nøkkel og kjørbare eksempler i API-guiden.

Responsen er et JSON-objekt. Tabellenes typer gjelder når feltet har en verdi. Ukjente opplysninger kan være null, og lister kan være tomme. Tekstfelter kan også være tomme strenger.

Prosjektet

Felt	Type	Forklaring
`public_id`	Heltall	Prosjektets offentlige ID. Bruk denne ved henting av prosjektet og som identifikator i integrasjonen.
`name`	Streng	Prosjektets navn.
`url_name`	Streng	Full URL til prosjektet hos Norsk Byggedata.
`meta_description`	Streng	Kort beskrivelse av prosjektet.
`project_summary`	Liste	Prosjektbeskrivelsen, delt inn i seksjoner. Hver seksjon har `heading` (overskrift) og `paragraph` (avsnitt), begge som strenger.
`updated_at`	Streng	Tidspunkt basert på prosjektets kildegrunnlag. Se hvordan tidspunktet skal tolkes.
`construction_stage`	Streng	Byggetrinn. Verdien er en JSON-kodet liste inne i en streng, for eksempel `"[1, 2]"`. Dekod strengen for å få en liste med byggetrinn. Prosjektets utviklingsfase finnes i `development_phase`.
`development_phase`	Streng	Navnet på prosjektets utviklingsfase.
`sector`	Streng	Prosjektets hovedkategori.
`sub_sector`	Streng	Prosjektets underkategori.
`contract_type`	Streng	Entrepriseform, for eksempel totalentreprise.
`project_type`	Streng	Type prosjekt, for eksempel nybygg eller rehabilitering.

Hva betyr updated_at?

updated_at viser hvor ferskt prosjektets kildegrunnlag er. Tidspunktet beregnes fra kildedatoer og tidspunktet kilder først ble knyttet til prosjektet. Datoer fra tilknyttede plandokumenter inngår også.

Formatet er ISO 8601 i UTC, for eksempel 2026-09-21T11:09:48Z. Manglende tidspunkt kan være null. I eldre data kan 2000-01-01T00:00:00Z forekomme som plassholder for ukjent dato.

Tidslinje

timeline inneholder objektene construction_start (byggestart) og construction_end (ferdigstillelse). Begge har feltene nedenfor. Tidspunktene kan være planlagte eller faktiske; friteksten gir mer kontekst.

Felt	Type	Forklaring
`free_text`	Streng	Tidsangivelsen som fritekst, for eksempel «Høsten 2027».
`year`	Heltall	Årstallet, når det er kjent.
`month_index`	Heltall	Månedsnummer fra 1 (januar) til 12 (desember). Kan være `null` selv om året er kjent.
`month_name`	Streng	Norsk navn på måneden angitt i `month_index`.

Størrelse og verdi

Disse feltene ligger i objektet size_and_value.

Felt	Type	Forklaring
`sqm_total`	Heltall	Samlet areal i kvadratmeter.
`quantities_breakdown`	Streng	Spesifikasjon av mengder og størrelser. Inneholder en JSON-kodet liste som må dekodes separat. Oppføringene har `what` (hva som måles) og `quantity+unit` (mengde med enhet), for eksempel «Leiligheter» og «163 stk».
`relative_project_size`	Heltall	Relativ størrelse fra 1 (minst) til 10 (størst).
`contract_value`	Heltall	Registrert verdi for hovedkontrakten, i hele valutaenheter. Feltet henter den observerte kontraktsverdien, ikke vår beregnede verdi.
`contract_currency_id`	Heltall	Intern ID for valutaen til `contract_value`. Dette feltet inneholder en ID, ikke en valutakode som `NOK`.

Adresse

Disse feltene ligger i objektet address.

Felt	Type	Forklaring
`latitude`	Tall	Breddegrad.
`longitude`	Tall	Lengdegrad.
`street_address`	Streng	Gateadresse.
`postal_code`	Streng	Postnummer. Behold det som tekst for å bevare eventuelle innledende nuller.
`city`	Streng	Poststedet som tilhører postnummeret.
`country`	Streng	Landets navn.

Kategorisering og fase

Objektene categorization og phase gjentar opplysninger som også finnes andre steder i responsen.

Felt	Type	Forklaring
`categorization.project_type`	Streng	Samme verdi som `project_type`.
`categorization.main_category`	Streng	Samme verdi som `sector`.
`categorization.sub_category`	Streng	Samme verdi som `sub_sector`.
`phase.name`	Streng	Samme verdi som `development_phase`.
`phase.construction_start_str`	Streng	Samme verdi som `timeline.construction_start.free_text`.
`phase.construction_end_str`	Streng	Samme verdi som `timeline.construction_end.free_text`.

Selskaper og personer

companies_and_people er en liste med selskapsroller og tilhørende kontaktpersoner. Samme selskap og samme person kan forekomme flere ganger med ulike roller i prosjektet. ID-ene identifiserer selskapet eller personen, ikke en unik rolleoppføring.

Felt	Type	Forklaring
`company_id`	Heltall	Selskapets interne ID hos Norsk Byggedata. Dette er ikke organisasjonsnummeret.
`company_name`	Streng	Selskapets navn.
`company_email_address`	Streng	Selskapets e-postadresse.
`company_phone_number`	Streng	Selskapets telefonnummer.
`company_role`	Streng	Selskapets rolle i prosjektet.
`engagement_stage`	Streng	Status for selskapets involvering i prosjektet, for eksempel knyttet til tilbud eller kontrakt.
`people`	Liste	Kontaktpersoner tilknyttet denne oppføringen, med feltene nedenfor.

Personer uten selskapstilknytning kan ligge i en egen oppføring med company_id: null, tomt company_name og company_role: "Other stakeholders". Selskapets kontaktfelter og engagement_stage kan mangle i denne oppføringen.

Felt i people	Type	Forklaring
`user_id`	Heltall	Personens interne ID hos Norsk Byggedata.
`first_name`	Streng	Fornavn.
`last_name`	Streng	Etternavn.
`email`	Streng	Personens e-postadresse.
`phone_number`	Streng	Personens telefonnummer.
`project_role`	Streng	Personens rolle i prosjektet.

Med testnøkkelen maskeres personenes navn, e-post og telefonnummer, for eksempel A..., P..., ...@multiconsult.no og +47.... Roller og ID-er beholdes. En selskapsnøkkel med API-tilgang gir de tilgjengelige kontaktopplysningene. Det er API-nøkkelen som avgjør dette, uavhengig av innlogging i nettleseren.