How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VNG Realisatie Referentielijsten API

The Referentielijsten API from VNG Realisatie — 7 operation(s) for referentielijsten.

VNG Realisatie Referentielijsten API is one of 42 APIs that VNG Realisatie publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 42 JSON Schema definitions.

Tagged areas include Referentielijsten. The published artifact set on APIs.io includes an OpenAPI specification and 42 JSON Schemas.

This API exposes 7 operations across 7 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 00.01.00.

Requests are made against 2 base URLs: https://virtserver.swaggerhub.com/VNGRealisatie/api/klantinteracties/v00, https://www.voorbeeldgemeente.nl/api/klantinteracties/v00.

7 operations 7 paths 16 schemas 7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
00.01.00
Base URL
https://zaken-api.vng.cloud/api/v1
Resource Areas
1

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 POST. Each is listed below with its method, path, parameters, and response codes.

Referentielijsten 7
POST
/_haal_referentielijsten_waarden_op
Haalreferentielijstenop
haalreferentielijstenop body → 200400401403409410415429
POST
/_raadpleeg_kanaal
Raadpleegkanaal
raadpleegkanaal body → 200400401403409410415429
POST
/_raadpleeg_land
Raadpleegland
raadpleegland body → 200400401403409410415429
POST
/_raadpleeg_soort_digitaal_adres
Raadpleegsoortdigitaaladres
raadpleegsoortdigitaaladres body → 200400401403409410415429
POST
/_raadpleeg_soort_extern_id
Raadpleegsoortexternid
raadpleegsoortexternid body → 200400401403409410415429
POST
/_raadpleeg_soort_object
Raadpleegsoortobject
raadpleegsoortobject body → 200400401403409410415429
POST
/_raadpleeg_voorkeurstaal
Raadpleegvoorkeurstaal
raadpleegvoorkeurstaal body → 200400401403409410415429

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Referentielijsten_parameters (6 properties), Referentielijstbody (6 properties), SoortExternId (5 properties), Land (4 properties). Each schema is shown below with its type and property counts.

Referentielijstbody
object
Bevat waarden van referentielijsten.
6 properties
SoortExternId
object
Een opsomming van de soorten externe identificatiecodes met de bijbehorende externe registers.
5 properties 5 required
Referentielijsten_parameters
object
6 properties
SoortPartij
string
De typering van de partij.
Voorkeurstaal_parameters
object
Parameter voor het raadplegen van de voorkeurstaal.
1 property 1 required
Kanaal
object
Een opsomming van de kanalen waarlangs de gemeente klantcontacten kan hebben.
3 properties 3 required
SoortObject_parameters
object
Parameter voor het raadplegen van een Soort object
1 property 1 required
SoortExternId_parameters
object
Parameter voor het raadplegen van het soort extern id.
1 property 1 required
Voorkeurstaal
object
Een opsomming van de talen waarin de gemeente klantcontacten kan hebben.
3 properties 3 required
Kanaal_parameters
object
Parameter voor het raadplegen van het kanaal.
1 property 1 required
SoortObject
object
Een opsomming van de soorten objecten waarmee een koppeling gelegd wordt vanuit het register klantinteracties.
3 properties 3 required
Land
object
Een opsomming van alle huidige en voormalige landen met hun codes, namen en geldigheidstermijnen.
4 properties 4 required
SoortDigitaalAdres
object
Een opsomming van de type digitaal adres waarlangs de gemeente klantcontacten kan hebben.
3 properties 3 required
SoortDigitaalAdres_parameters
object
Parameter voor het raadplegen van het kanaal.
1 property 1 required
IndicatieJaNee
boolean
Land_parameters
object
Parameter voor het raadplegen van het kanaal.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vng-realisatie-referentielijsten-api-openapi.yml Raw ↑

Other APIs VNG Realisatie publishes across the network.

VNG Realisatie Applicaties API
VNG Realisatie Besluiten API
VNG Realisatie Besluitinformatieobjecten API
VNG Realisatie Besluittypen API
VNG Realisatie Bestandsdelen API
VNG Realisatie Catalogussen API
VNG Realisatie Digitale adressen API
VNG Realisatie Domains API
VNG Realisatie Eigenschappen API
VNG Realisatie Enkelvoudiginformatieobjecten API
VNG Realisatie Events API
VNG Realisatie Geautomatiseerde actoren API
Where this information came from

This is an independent, third-party profile of VNG Realisatie Referentielijsten API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.