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 Zaken API

Een zaak mag (in principe) niet meer gewijzigd worden als de `archiefstatus` een andere status heeft dan "nog_te_archiveren". Voor praktische redenen is er geen harde validatie regel aan de provider kant.

VNG Realisatie Zaken 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 zaken. The published artifact set on APIs.io includes an OpenAPI specification and 42 JSON Schemas.

This API exposes 21 operations across 9 paths, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version 1.5.1.

Requests are made against a single base URL, https://zaken-api.vng.cloud/api/v1/.

21 operations 9 paths 40 schemas 3 DELETE8 GET2 HEAD2 PATCH4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.5.1
Base URL
https://zaken-api.vng.cloud/api/v1
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

VNG Realisatie Zaken API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (JWT-Claims).

Paths & Operations 21

Across 9 paths, the API surfaces 21 operations — 3 DELETE, 8 GET, 2 HEAD, 2 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

zaken 21

Een zaak mag (in principe) niet meer gewijzigd worden als de archiefstatus een andere status heeft dan "nogtearchiveren". Voor praktische redenen is er geen harde validatie regel…

GET
/zaken
Alle ZAAKen opvragen
zaak_list 47 params → 200400401403406409410412
POST
/zaken
Maak een ZAAK aan
zaak_create 5 params body → 201400401403406409410412
GET
/zaken/{uuid}
Een specifieke ZAAK opvragen
zaak_retrieve 5 params → 200401403404406409410412
PUT
/zaken/{uuid}
Werk een ZAAK in zijn geheel bij
zaak_update 6 params body → 200400401403404406409410
PATCH
/zaken/{uuid}
Werk een ZAAK deels bij
zaak_partial_update 6 params body → 200400401403404406409410
DELETE
/zaken/{uuid}
Verwijder een ZAAK
zaak_destroy 5 params → 204401403404406409410412
HEAD
/zaken/{uuid}
De headers voor een specifiek(e) ZAAK opvragen
zaak_headers 4 params → 200
GET
/zaken/{zaak_uuid}/audittrail
Alle audit trail regels behorend bij de ZAAK
audittrail_list 1 param → 200401403406409410415429
GET
/zaken/{zaak_uuid}/audittrail/{uuid}
Een specifieke audit trail regel opvragen
audittrail_retrieve 2 params → 200401403404406409410415
GET
/zaken/{zaak_uuid}/besluiten
Alle ZAAKBESLUITen opvragen
zaakbesluit_list 1 param → 200401403406409410415429
POST
/zaken/{zaak_uuid}/besluiten
Maak een ZAAKBESLUIT aan
zaakbesluit_create 4 params body → 201400401403406409410415
GET
/zaken/{zaak_uuid}/besluiten/{uuid}
Een specifiek ZAAKBESLUIT opvragen
zaakbesluit_retrieve 2 params → 200401403404406409410415
DELETE
/zaken/{zaak_uuid}/besluiten/{uuid}
Verwijder een ZAAKBESLUIT
zaakbesluit_destroy 4 params → 204401403404406409410415
GET
/zaken/{zaak_uuid}/zaakeigenschappen
Alle ZAAKEIGENSCHAPpen opvragen
zaakeigenschap_list 1 param → 200401403406409410415429
POST
/zaken/{zaak_uuid}/zaakeigenschappen
Maak een ZAAKEIGENSCHAP aan
zaakeigenschap_create 4 params body → 201400401403406409410415
GET
/zaken/{zaak_uuid}/zaakeigenschappen/{uuid}
Een specifieke ZAAKEIGENSCHAP opvragen
zaakeigenschap_retrieve 3 params → 200401403404406409410415
PUT
/zaken/{zaak_uuid}/zaakeigenschappen/{uuid}
Werk een ZAAKEIGENSCHAP in zijn geheel bij
zaakeigenschap_update 3 params body → 200400401403404406409410
PATCH
/zaken/{zaak_uuid}/zaakeigenschappen/{uuid}
Werk een ZAAKEIGENSCHAP deels bij
zaakeigenschap_partial_update 3 params body → 200400401403404406409410
DELETE
/zaken/{zaak_uuid}/zaakeigenschappen/{uuid}
Verwijder een ZAAKEIGENSCHAP
zaakeigenschap_destroy 2 params → 204401403404406409410415
HEAD
/zaken/{zaak_uuid}/zaakeigenschappen/{uuid}
De headers voor een specifiek(e) ZAAKEIGENSCHAP opvragen
zaakeigenschap_headers 3 params → 200
POST
/zaken/_zoek
Voer een (geo)-zoekopdracht uit op ZAAKen
zaak__zoek 4 params body → 200400401403406409410412

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are ZaakZoek (47 properties), PatchedZaak (41 properties), Zaak (41 properties), AuditTrail (16 properties). Each schema is shown below with its type and property counts.

Fout
object
Formaat van HTTP 4xx en 5xx fouten.
6 properties 5 required
GeometryCollection
object
GeoJSON multi-polygon geometry
MultiPolygon
object
GeoJSON multi-polygon geometry
PaginatedZaakList
object
4 properties
MultiPoint
object
GeoJSON multi-point geometry
BronEnum
string
GeoWithin
object
1 property
OrderingEnum
string
BlankEnum
Verlenging
objectnull
Gegevens omtrent het verlengen van de doorlooptijd van de behandeling van de ZAAK
2 properties 2 required
Point
object
GeoJSON point geometry
GeoJSONGeometry
object
GeometryTypeEnum
string
ArchiefstatusEnum
string
RelevanteZaak
object
2 properties 2 required
ZaakZoek
object
47 properties
Polygon
object
GeoJSON polygon geometry
Rol_omschrijvingGeneriekEnum
string
PatchedZaak
object
Set gegevensgroepdata from validated nested data. Usage: include the mixin on the ModelSerializer that has gegevensgroepen.
41 properties
ValidatieFout
object
Formaat van HTTP 4xx en 5xx fouten.
7 properties 6 required
Processobject
objectnull
Specificatie van de attribuutsoort van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking heeft en dat bepalend is voor d…
4 properties 4 required
FieldValidationError
object
Formaat van validatiefouten.
3 properties 3 required
BetalingsindicatieEnum
string
Geometry
object
GeoJSON geometry
1 property 1 required
ZaakBesluit
object
A type of ModelSerializer that uses hyperlinked relationships with compound keys instead of primary key relationships. Specifically: A 'url' field is included…
3 properties 3 required
Rol_betrokkeneTypeEnum
string
Point2D
array
PatchedZaakEigenschap
object
A type of ModelSerializer that uses hyperlinked relationships with compound keys instead of primary key relationships. Specifically: A 'url' field is included…
6 properties
Opschorting
objectnull
Gegevens omtrent het tijdelijk opschorten van de behandeling van de ZAAK
2 properties 2 required
AardRelatieEnum
string
Wijzigingen
object
2 properties
MultiLineString
object
GeoJSON multi-line-string geometry
NullEnum
Zaak
object
Set gegevensgroepdata from validated nested data. Usage: include the mixin on the ModelSerializer that has gegevensgroepen.
41 properties 15 required
MaximaleVertrouwelijkheidaanduidingEnum
string
AuditTrail
object
16 properties 9 required
ZaakEigenschap
object
A type of ModelSerializer that uses hyperlinked relationships with compound keys instead of primary key relationships. Specifically: A 'url' field is included…
6 properties 6 required
ArchiefnominatieEnum
string
LineString
object
GeoJSON line-string geometry
ZaakKenmerk
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vng-realisatie-zaken-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 Zaken 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.