Skip to content

API statuses

All our APIs have an attached status that informs about their progress and availability.

In development

An API in early prototyping. It may be accessible only for testing through a sandbox service or an integration environment.

Beta

An API that’s available in a production environment. It's likely it will undergo some transformative changes after we receive feedback.

In production

An API available in a production environment. We don’t expect further changes that might disrupt compatibility.

Internal

This API is not yet open for integration by third parties.

Under review for deprecation

An API that’s undergoing assessment for potential deprecation. We're thinking about phasing it out. If you have any concerns, contact us.

Deprecated

An API that is still available, although we intend to retire it. It’s unlikely that there will be new updates, so we do not accept new integrations.

Retired

This API is no longer available.

 

This list follows the classification used by England's NHS Digital API Catalogue.

 

What do you think of this page?

© NHS Education for Scotland 2026