Skip to main content
Table of contents

NHSmail APIs

Overview

Use these APIs to connect your local, regional or national applications or services to NHSmail.

You can:

  • work with email messages, calendar, task and contact information 
  • access mailboxes
  • get client configuration data and endpoint URLs from Exchange

The Microsoft APIs used are:

  • Exchange Web Service (EWS) Managed API 2.0  - to work with mailboxes, messages, calendars, tasks and contacts
  • Exchange Web Service (EWS) API - to work with mailboxes, messages, calendars, tasks and contacts
  • SOAP Autodiscover  - to get client configuration data and endpoint URLs

For compatibility with Office 365, use EWS Managed API 2.0 and not the EWS API.

Documentation

NHSmail APIs documentation

Endpoint

https://digital.nhs.uk/developer/api-catalogue/nhsmail

Contact

https://digital.nhs.uk/developer/help-and-support