Spine Directory Service - LDAP API

Overview

Use this API to access details from the Spine Directory Service (SDS) relating to:

organisations - NHS organisations, their sites and departments
people - healthcare workers who are Spine users, including their organisation and role
systems registered with Spine

This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development.

You must do this before you can go live (see ‘Onboarding’ below).

The following APIs are related to this one:

Spine Directory Service - FHIR API - an internet-facing, FHIR-conformant API which might be a better way to access SDS for some use cases
Organisation Data Service - FHIR API - simple access to a reduced dataset of the full ODS record
Organisation Data Service - ORD API - access to the full record dataset from ODS
Query Accredited System Information - SOAP API - this API is now deprecated

This API is a platinum service, meaning it is operational and supported 24 hours a day, 365 days a year.

For more details, see service levels.

It is not available on the internet.

For a similar API that is available on the internet, consider Spine Directory Service - FHIR API.

You can test this API using our Path to Live environments.

You must get your software onboarded before it can go live.

Contact us before onboarding with this API. It uses the Common Assurance Process (CAP) which is tailored for each NHS service.