integrations.sh
← all integrations

DigitalNZ API

OpenAPI apis-guru open_data

OpenAPI specification of DigitalNZ's Record API.
For more information about the API see .
To learn more about the metadata/fields used in the API see the .
To get a sense of what content is available via the API take a look at the search feature on the .
The specify how developers can use the DigitalNZ API.

Homepage
https://api.apis.guru/v2/specs/digitalnz.org/3.json
Provider
digitalnz.org
OpenAPI version
3.0.1
Spec (JSON)
https://api.apis.guru/v2/specs/digitalnz.org/3/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/digitalnz.org/3/openapi.yaml

Tools (5)

Extracted live via the executor SDK.

  • apiCalls.getRecordsFormat

    This is the main search endpoint allowing queries against the records database.

  • apiCalls.getRecordsRecordIdFormat

    If you know its record_id you can use this endpoint to view all metadata associated with that specific record.

  • apiCalls.getRecordsRecordIdMoreLikeThisFormat

    This feature returns a set of search results that are similar (ie have similar metadata) to a specific record.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools