UKHSA API Developer Portal

Discover, try out and subscribe to the APIs that UKHSA teams build and share.

Sign up Explore APIs

Getting started

For API publishers

  • Onboard your API with the UKHSA Platform Team and follow the API governance process.

  • Group related APIs into products based on their functionality, audience or access requirements.

  • Document every operation: endpoints, request and response formats, parameters, headers and authentication.

  • State the security requirements, including authentication methods and authorisation scopes.

  • Configure access policies for your APIs and products before you publish them.

For API subscribers

  • Sign in with your UKHSA Microsoft Entra ID account, or sign up with your email address if you're outside UKHSA.

  • Browse the catalogue and read the documentation for the API you need.

  • Request a subscription to the relevant product to get your keys.

  • Try operations interactively from the API details page before you write any code.

  • Manage your subscriptions, view usage and rotate or revoke keys from your profile.

Using the APIs

Every API in this catalogue is published through Azure API Management. Once you have subscribed to a product, call the gateway with your subscription key and an access token.

Use the API details pages to read the full specification and send test requests directly from your browser.

curl -X GET "{gateway-url}/{api-path}/{operation}" \
  -H "Ocp-Apim-Subscription-Key: {your-subscription-key}" \
  -H "Authorization: Bearer {access-token}"

Ready to start?

Sign up for an account, or browse the catalogue to see what is available.

Sign up Explore APIs