v2

latestOpenAPI 3.1.02026-07-31131352.3 KB

Public endpoints

APIs

Get API by id

Returns a single API by id.

get/apis/{id}

Response

idstring required

The unique identifier for an API

titlestring required

The title of the API

summarystring nullable required

Short plain-text summary of the API. Derived from description when no explicit summary is available.

descriptionstring required

The description of the API

adrScorenumber nullable required

The ADR score of the API

oasUrlstring uri nullable required

The URL of the OAS document

authstring[] required

The authentication methods supported by the API

docsUrlstring uri nullable required

The URL to the documentation of the API

Example response

{
  "id": "dicF0B3HR",
  "contact": {
    "email": "developer.overheid@geonovum.nl",
    "name": "Developer Overheid",
    "url": "https://developer.overheid.nl"
  },
  "title": "API register API v1",
  "summary": "Short summary of the API register.",
  "description": "This is version 1 of the API register. This description can also contain Markdown.",
  "organisation": {
    "uri": "https://developer.overheid.nl",
    "label": "developer.overheid.nl"
  },
  "adrScore": 85,
  "lifecycle": {
    "status": "deprecated",
    "version": "1.0.0",
    "deprecated": "2025-10-10",
    "sunset": "2027-11-11"
  },
  "oasUrl": "https://api.developer.overheid.nl/api-register/v1/openapi.json",
  "auth": [
    "OAuth2"
  ],
  "docsUrl": "https://developer.overheid.nl/kennisbank/",
  "servers": [
    {
      "url": "https://api.developer.overheid.nl/api-register/v1",
      "description": "Production server"
    }
  ]
}