Brønnøysundregistrene Frivillighetsregisteret API

openapi: 3.2.0
info:
  title: Brreg No Frivillighetsregisteret API
  version: 2.0.0
  contact:
    email: opendata@brreg.no
  license:
    name: Norsk lisens for offentlige data (NLOD)
    url: https://data.norge.no/nlod/no/2.0
  x-logo:
    url: https://scf.brreg.no/bilder/brreg_logo.svg
    altText: Brønnøysundregistrene, snarvei til fremsiden
    href: https://data.brreg.no/enhetsregisteret/oppslag
  description: 'Operations tagged frivillighetsregisteret across 2 of this provider''s published API definitions: brreg-no-enhetsregisteret-openapi.json, brreg-no-enhetsregisteret-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://data.brreg.no
  description: Server
security: []
tags:
- name: frivillighetsregisteret
  x-displayName: Frivillighetsregisteret
  description: Operasjoner mot frivillighetsregisteret.
paths:
  /frivillighetsregisteret/api/frivillige-organisasjoner:
    get:
      tags:
      - frivillighetsregisteret
      operationId: sokFrivilligeOrganisasjoner
      parameters:
      - name: searchAfter
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
          example: '388348542'
        description: Henter neste bolk med frivillige organisasjoner. Sett denne til den siste verdien du fikk fra forrige bolk. Verdien som du skal sette avhenger av hva du sorterer på. Den eneste sorteringen som vi støtter nå er 'organisasjonsnummer'
      - name: size
        in: query
        required: false
        schema:
          type:
          - integer
          - 'null'
          format: int32
          default: 100
          example: 50
        description: Begrenser maks antall frivillige organisasjoner i responsen
      - name: spraak
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
          example: NOB
        description: "Velger språk for kodeverk-beskrivelser. APIet legger til kodeverk-beskrivelser i responsen, men bare hvis du setter dette parameteret.\n\nKjente verdier: \n- NOB (Norsk bokmål)\n"
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrivilligeOrganisasjoner'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/FrivilligeOrganisasjoner'
        '400':
          description: '400'
      description: 'Dette endepunktet lar deg søke blant alle frivillige organisasjoner.


        Her kan du hente en totalbestand med alle frivillige organisasjoner ved hjelp av paginering. Historikk eller slettede frivillige organisasjoner er ikke med i totalbestanden.


        #### Om Paginering:


        Av dataintegritet- og ytelseshensyn bruker dette endepunktet "searchAfter" fremfor klassisk paginering. Det fungerer slik:

        - Først setter du "size" parameteret til ønsket sidestørrelse.

        - Så gjør du det første API-kallet, dette gir deg den første siden.

        - For å hente neste side, sett "searchAfter" parameteret til det siste/høyeste organisasjonsnummeret du fikk fra den forrige siden.

        - Hent nye sider helt til du mottar færre objekter enn det "size" parameteret tilsier. Da er du på siste side.


        Du kan også bruke "next" lenken fra API-responsen for å hente neste side. Next lenken er satt så lenge antall organisasjoner i responsen det samme antallet som size-parameteret tilsier.'
      summary: Søk i frivillige organisasjoner
    servers:
    - url: https://data.brreg.no
      description: Server
  /frivillighetsregisteret/api/frivillige-organisasjoner/{organisasjonsnummer}:
    get:
      tags:
      - frivillighetsregisteret
      operationId: hentFrivilligOrganisasjon
      parameters:
      - name: organisasjonsnummer
        in: path
        required: true
        schema:
          type: string
          example: '388348542'
        description: Organisasjonsnummeret til den frivillige organisasjonen
      - name: spraak
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
          example: NOB
        description: "Velger språk for kodeverk-beskrivelser. APIet legger til kodeverk-beskrivelser i responsen, men bare hvis du setter dette parameteret.\n\nKjente verdier: \n- NOB (Norsk bokmål)\n"
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrivilligOrganisasjon'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/FrivilligOrganisasjon'
        '404':
          description: Ikke funnet
      description: Hent informasjon om en frivillig organisasjon fra frivillighetsregisteret
      summary: Hent én frivillig organisasjon med organisasjonsnummer
    servers:
    - url: https://data.brreg.no
      description: Server
  /frivillighetsregisteret/api/frivillige-organisasjoner/totalbestand/csv:
    get:
      tags:
      - frivillighetsregisteret
      operationId: frivilligeOrganisasjonerTotalbestandCsv
      x-codeSamples:
      - label: Default
        lang: shell
        source: curl 'https://data.brreg.no/frivillighetsregisteret/api/frivillige-organisasjoner/totalbestand/csv' -X GET -J -O
      responses:
        '200':
          description: '200'
        '404':
          description: '404'
        '500':
          description: '500'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      description: 'Last ned totalbestand av frivillige organisasjoner i csv format.


        Både linjeskift og anførselstegn kan forekomme i celler i denne CSV filen. Derfor er alle celler "escapet" med anførselstegn.

        Anførselstegn i selve teksten kommer som to anførselstegn på rad. Dette for å unngå at cellen terminerer for tidlig.

        Du må bruke en CSV parser som kan konfigureres til å handtere dette riktig.

        I OpenCSV for Java konfigurerer vi "quotechar" og "escapechar". Begge setter vi til anførselstegn (").


        |Beskrivelser av felter i rekkefølge |

        |-----------------------------------------------------|

        | Organisasjonsnummer til enheten |

        | Enhetens navn |

        | Enhetens organisasjonsform |

        | Beskrivelse enhetens organisasjonsform |

        | Land (forretningsadresse) |

        | Landkode (forretningsadresse) |

        | Postnummer (forretningsadresse) |

        | Poststed (forretningsadresse) |

        | Adresse (forretningsadresse) |

        | Kommune (forretningsadresse) |

        | Kommunenummer (forretningsadresse) |

        | Land (postadresse) |

        | Landkode (postadresse) |

        | Postnummer (postadresse) |

        | Poststed (postadresse) |

        | Adresse (postadresse) |

        | Kommune (postadresse) |

        | Kommunenummer (postadresse) |

        | Telefon |

        | Mobil |

        | Dato sist innført i Frivillighetsregisteret |

        | Dato første gang innført i Frivillighetsregisteret |

        | ICNPO-nummer for aktivitet 1 |

        | Beskrivelse ICNPO-kategori 1 |

        | ICNPO-nummer for aktivitet 2 |

        | Beskrivelse ICNPO-kategori 2 |

        | ICNPO-nummer for aktivitet 3 |

        | Beskrivelse ICNPO-kategori 3 |

        | Om den frivillige organisasjonen har registrert vedtekter (plikter å sende oppdaterte vedtekter når disse endres) |

        | Dato sist vedtekter ble oppdatert |

        | Om den frivillige organisasjonen påtar seg å innrapportere årsregnskap til regnskapsregisteret |

        | Avslutningsdato for regnskapsperioden. Formatet er: dd.mm |

        | Årstall for sist godkjente frivillig rapportert årsregnskap |

        | Registreringsdato i Regnskapsregisteret for sist innsendte frivillig rapportert årsregnskap |

        | Om den frivillige organisasjonen deltar i grasrotandelen |

        | Fra-dato den frivillige organisasjonen er utestengt fra å delta i grasrotandelen |

        | Til-dato den frivillige organisasjonen er utestengt fra å delta i grasrotandelen |

        | Kontonummer |

        | Om den frivillige organisasjonen har påtegninger |

        | E-postadresse |'
      summary: Last ned CSV totalbestand fra frivillighetsregisteret
    servers:
    - url: https://data.brreg.no
      description: Server
  /frivillighetsregisteret/api/icnpo-kategorier:
    get:
      tags:
      - frivillighetsregisteret
      operationId: hentIcnpoKategorier
      parameters:
      - name: spraak
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
          example: NOB
        description: "Velger språk for kodeverk-beskrivelser.\n\nKjente verdier: \n- NOB (Norsk bokmål)\n"
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IcnpoKategorier'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/IcnpoKategorier'
        '400':
          description: '400'
      description: Hent ICNPO kategorier (International Classification of Non-Profit Organisation)
      summary: Hent ICNPO kategorier
    servers:
    - url: https://data.brreg.no
      description: Server
  /frivillighetsregisteret/api/informasjonstyper:
    get:
      tags:
      - frivillighetsregisteret
      operationId: hentInformasjonstyperIFrivillighetsregisteret
      parameters:
      - name: spraak
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
          example: NOB
        description: "Velger språk for kodeverk-beskrivelser.\n\nKjente verdier: \n- NOB (Norsk bokmål)\n"
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InformasjonstyperFrivillighetsregisteret'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/InformasjonstyperFrivillighetsregisteret'
        '400':
          description: '400'
      description: Hent alle informasjonstyper i Frivillighetsregisteret.
      summary: Hent informasjonstyper i Frivillighetsregisteret
    servers:
    - url: https://data.brreg.no
      description: Server
components:
  schemas:
    FrivilligOrganisasjonSlettet:
      type: object
      additionalProperties: false
      properties:
        organisasjonsnummer:
          type: string
          example: '388348542'
          description: Organisasjonsnummeret til den frivillige organisasjonen
        frivilligOrganisasjonsstatus:
          type: string
          example: frivilligOrganisasjonsstatus.innfoert
          description: Intern organisasjonsstatus, brukes av Brønnøysundregistrene
        slettetDato:
          type: string
          format: date
          example: '2025-02-18'
          description: Dato den frivillige organisasjonen ble slettet i frivillighetsregisteret. Kun satt hvis organisasjonen er slettet, ellers null.
        _links:
          $ref: '#/components/schemas/Links'
      required:
      - organisasjonsnummer
      - frivilligOrganisasjonsstatus
      - slettetDato
      - _links
    InternalServerError:
      type: object
      additionalProperties: false
      properties:
        timestamp:
          type: string
          example: 2024-01-05T07:36:21.523+0000
          description: Tidspunkter for når feilen oppstod
        status:
          type: number
          example: 500
          description: HTTP status koden
        error:
          type: string
          example: Internal Server Error
          description: Feilmelding
        message:
          type: string
          example: Internal Server Error
          description: Utdypende feilmelding
        path:
          type: string
          example: /enhetsregisteret/api/enheter
          description: Url sti som feilet
        trace:
          type: string
          example: b94669c0-425a-4b6c-ab30-504de8d9c127
          description: Send denne koden til oss for at vi skal lettere finne igjen feilen i våre logger
      required:
      - timestamp
      - status
      - error
      - message
      - path
      - trace
    FrivilligOrganisasjonInnfoert:
      type: object
      additionalProperties: false
      properties:
        organisasjonsnummer:
          type: string
          example: '388348542'
          description: Organisasjonsnummeret til den frivillige organisasjonen
        frivilligOrganisasjonsstatus:
          type: string
          example: frivilligOrganisasjonsstatus.innfoert
          description: Intern organisasjonsstatus, brukes av Brønnøysundregistrene
        kontonummer:
          type:
          - string
          - 'null'
          example: '123456789'
          description: Kontonummer
        innfoertDato:
          type: string
          format: date
          example: '2001-01-01'
          description: Dato den frivillige organisasjonen sist ble innført i Frivillighetsregisteret
        foersteGangInnfoert:
          type: string
          format: date
          example: '2001-01-01'
          description: Dato den frivillige organisasjonen første gang ble innført i Frivillighetsregisteret
        grasrotandel:
          $ref: '#/components/schemas/FrivilligOrganisasjonGrasrotandel'
        regnskapsrapportering:
          $ref: '#/components/schemas/FrivilligOrganisasjonRegnskapsrapportering'
        vedtekter:
          $ref: '#/components/schemas/FrivilligOrganisasjonVedtekter'
        icnpoKategorier:
          type: array
          items:
            $ref: '#/components/schemas/FrivilligOrganisasjonIcnpoKategori'
        paategninger:
          type: array
          items:
            $ref: '#/components/schemas/FrivilligOrganisasjonPaategning'
          example:
          - identifikatorInformasjonstype: informasjonstype.organisasjonsnummer
            paategning: Eksempel på påtegning på frivillig organisasjon AS
          - identifikatorInformasjonstype: informasjonstype.icnpokategori
            paategning: Eksempel på påtegning på kategori
        _links:
          $ref: '#/components/schemas/Links'
      required:
      - organisasjonsnummer
      - frivilligOrganisasjonsstatus
      - innfoertDato
      - foersteGangInnfoert
      - grasrotandel
      - icnpoKategorier
      - paategninger
      - _links
    FrivilligOrganisasjonPaategning:
      type: object
      additionalProperties: false
      properties:
        identifikatorInformasjonstype:
          type: string
          example: informasjonstype.organisasjonsnummer
          description: Informasjonstypen påtegningen gjelder
        navn:
          type:
          - string
          - 'null'
          example: Organisasjonsnummer
          description: Beskrivelse av informasjonstypen påtegningen gjelder
        sti:
          type: string
          example: $.organisasjonsnummer
          description: JSONPath uttrykk til feltet påtegningen gjelder. Uttrykket antar du starter fra FrivilligOrganisasjon objektet, selv hvis objektet er embedded i et array.
        paategning:
          type: string
          example: Eksempel på påtegning på frivillig organisasjon AS
          description: Påtegningen
        _links:
          $ref: '#/components/schemas/Links'
    InformasjonstyperFrivillighetsregisteret:
      type: object
      additionalProperties: false
      properties:
        _embedded:
          type:
          - object
          - 'null'
          properties:
            informasjonstyper:
              type: array
              items:
                $ref: '#/components/schemas/InformasjonstypeFrivillighetsregisteret'
          required:
          - informasjonstyper
        _links:
          $ref: '#/components/schemas/Links'
    IcnpoKategori:
      type: object
      additionalProperties: false
      properties:
        icnpoNummer:
          type: string
          example: '1100'
          description: Entydig identifikator for ICNPO-Kategori (International Classification of Non-Profit Organisation)
        navn:
          type: string
          example: Kunst og kultur
          description: Beskrivelse av ICNPO-kategorien
        spraakkode:
          type: string
          example: NOB
          description: Språkkode
        _links:
          $ref: '#/components/schemas/Links'
      required:
      - icnpoNummer
      - navn
      - spraakkode
    FrivilligOrganisasjonSistInnsendteAarsregnskap:
      type:
      - object
      - 'null'
      additionalProperties: false
      properties:
        regnskapsaar:
          type: integer
          format: int32
          example: 2024
          description: Årstall for sist godkjente frivillig rapportert årsregnskap
        registreringsdato:
          type: string
          format: date
          example: '2001-03-01'
          description: Registreringsdato i Regnskapsregisteret for sist innsendte frivillig rapportert årsregnskap
      required:
      - regnskapsaar
      - registreringsdato
    FrivilligOrganisasjonGrasrotandel:
      type: object
      additionalProperties: false
      properties:
        deltarI:
          type: boolean
          example: true
          description: Om den frivillige organisasjonen deltar i grasrotandelen
        utestengelsesperiode:
          $ref: '#/components/schemas/FrivilligOrganisasjonUtestengelsesperiode'
      required:
      - deltarI
    IcnpoKategorier:
      type: object
      additionalProperties: false
      properties:
        _embedded:
          type:
          - object
          - 'null'
          properties:
            icnpoKategorier:
              type: array
              items:
                $ref: '#/components/schemas/IcnpoKategori'
          required:
          - icnpoKategorier
        _links:
          $ref: '#/components/schemas/Links'
    FrivilligeOrganisasjoner:
      type: object
      additionalProperties: false
      properties:
        _embedded:
          type:
          - object
          - 'null'
          properties:
            frivilligeOrganisasjoner:
              type: array
              items:
                $ref: '#/components/schemas/FrivilligOrganisasjonInnfoert'
          required:
          - frivilligeOrganisasjoner
        _links:
          $ref: '#/components/schemas/Links'
    FrivilligOrganisasjonIcnpoKategori:
      type: object
      additionalProperties: false
      properties:
        kategori:
          type: string
          example: ICNPOKategori.kunstOgKultur
          description: Entydig intern identifikator for ICNPO-Kategori, brukes ved oppretting og redigering av frivillig organisasjon i Brønnøyusundregistrene
        icnpoNummer:
          type: string
          example: '1100'
          description: Entydig identifikator for ICNPO-Kategori (International Classification of Non-Profit Organisation)
        navn:
          type:
          - string
          - 'null'
          example: Kunst og kultur
          description: Tekstlig beskrivelse av ICNPO-kategorien. Kun satt dersom du sender med query-parameteret 'spraak', ellers null.
        rekkefoelge:
          type: integer
          format: int32
          example: 1
          description: Rekkefølge for ICNPO-kategori
        _links:
          $ref: '#/components/schemas/Links'
      required:
      - kategori
      - icnpoNummer
      - rekkefoelge
    Links:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/Link'
    Link:
      type: object
      additionalProperties: false
      properties:
        href:
          type: string
    FrivilligOrganisasjon:
      type: object
      additionalProperties: false
      oneOf:
      - $ref: '#/components/schemas/FrivilligOrganisasjonInnfoert'
      - $ref: '#/components/schemas/FrivilligOrganisasjonSlettet'
    InformasjonstypeFrivillighetsregisteret:
      type: object
      additionalProperties: false
      properties:
        identifikator:
          type: string
          example: informasjonstype.kontonummer
          description: Entydig identifikator for informasjonstype (felt)
        navn:
          type: string
          example: Kontonummer
          description: Beskrivelse av informasjonstypen (feltet)
        spraakkode:
          type: string
          example: NOB
          description: Språkkode
        _links:
          $ref: '#/components/schemas/Links'
      required:
      - identifikator
      - navn
      - spraakkode
    FrivilligOrganisasjonVedtekter:
      type:
      - object
      - 'null'
      additionalProperties: false
      properties:
        frivilligRegistrerteVedtekter:
          type: boolean
          example: true
          description: Om den frivillige organisasjonen har registrert vedtekter (plikter å sende oppdaterte vedtekter når disse endres)
        sistOppdaterteVedtekter:
          type:
          - string
          - 'null'
          format: date
          example: '2001-01-01'
          description: Dato sist vedtekter ble oppdatert
      required:
      - frivilligRegistrerteVedtekter
    FrivilligOrganisasjonUtestengelsesperiode:
      type:
      - object
      - 'null'
      additionalProperties: false
      properties:
        fraDato:
          type: string
          format: date
          example: '2001-01-01'
          description: Utestengt fra dato
        tilDato:
          type:
          - string
          - 'null'
          format: date
          example: '2001-03-01'
          description: Utestengt til dato. Kan være utestengt på ubestemt tid, da er tilDato null.
      required:
      - fraDato
      description: Perioden den frivillige organisasjonen er utestengt fra å delta i grasrotandelen
    FrivilligOrganisasjonRegnskapsrapportering:
      type:
      - object
      - 'null'
      additionalProperties: false
      properties:
        harPaatattSegRapporteringsplikt:
          type: boolean
          example: true
          description: Om den frivillige organisasjonen påtar seg å innrapportere årsregnskap til regnskapsregisteret
        avslutningsdatoForRegnskapsperiode:
          type:
          - string
          - 'null'
          example: '24.12'
          description: 'Avslutningsdato for regnskapsperioden. Formatet er: dd.mm'
        sistInnsendteAarsregnskap:
          $ref: '#/components/schemas/FrivilligOrganisasjonSistInnsendteAarsregnskap'
      required:
      - harPaatattSegRapporteringsplikt
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- brreg-no-enhetsregisteret-openapi.json
- brreg-no-enhetsregisteret-openapi.yml