APIs

API Design and implementation

Use the Zalando RESTful API Guidelines as the reference standard for API design.

The source repository is zalando/restful-api-guidelines.

Personal data in URLs

In addition to the Zalando guidelines, HMCTS services must not transmit personal data in URL paths or query strings. This information can be inadvertently exposed via client, network, and server logs.

Where personal data is required, transmit it in the request body or, where that is not possible (e.g. GET requests), in HTTP headers.

Versioning

Use content type negotiation or endpoint naming to version the API.

Do not make backward incompatible changes to existing endpoints.

See the official guidance in the TGL

Documentation

Use OpenAPI for API documentation.

Maintain a central repository of API documentation.

This page was last reviewed on 25 March 2025. It needs to be reviewed again on 25 March 2026 by the page owner platops-build-notices .

This page was set to be reviewed before 25 March 2026 by the page owner platops-build-notices. This might mean the content is out of date.