Sign in

v2

latestOpenAPI 3.1.02026-07-31131352.3 KB
Public endpoints
APIs

List APIs

Returns a list of APIs included in the register. Supports the same filter query parameters as the filters endpoint, combines them with the optional q search term, and sorts the filtered result before pagination.

get/apis

Query parameters

pageinteger

Page number (1-based).

perPageinteger

Number of results per page.

sortBy'title' | 'adrScore' | 'version'
Example:version

Property used to sort the filtered API collection. Version values are compared semantically; APIs without a sortable ADR score or version are placed last.

sortOrder'asc' | 'desc'
Example:desc

Direction used to sort the filtered API collection.

qstring

Search term to combine with API filters. Matches API title.

organisationstring uri

Filter on organisation URI.

idsstring
Example:dicF0B3HR,diC1D4EHR

Comma-separated list of API IDs.

statusstring[]

Filter on lifecycle status. Repeat the parameter or use comma-separated values.

oasVersionstring[]

Filter on the API version from the OAS info.version field. Repeat the parameter or use comma-separated values.

adrScorestring[]

Filter on stored ADR score. Use exact scores or 'unknown' for APIs without a stored score.

[
  "88"
]
authstring[]

Filter on the authentication/security type derived from the OAS security definition.

Response

OK

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

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"
    }
  }
]
All 13 operations