Skip to main content
Spine Directory Service - LDAP API

Access details of organisations, people and systems registered in the Spine Directory Service (SDS) using our LDAP API.

Overview

If you are developing a new integration, consider using the Spine Directory Service - FHIR API instead.

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

  • organisations - NHS organisations, their sites and departments
  • people - Spine users including their organisation and role
  • systems registered with Spine

For more details, see the Spine External Interface Specification (EIS) Part 5 - Spine Directory Services (SDS).


Who can use this API

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). 


API Status

This API is stable.


Network access

You can access this API via the Health and Social Care Network (HSCN).

It is not available on the internet.

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

For more details, see Network access for APIs.


Security and authorisation

For details, see part 5 of the Spine External Interface Specification.


Testing

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


Onboarding

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

As part of onboarding, this API uses the Common Assurance Process (CAP), which is tailored for each NHS service. For more details, contact us.


Interactions

For details of interactions for this API, see part 5 of the Spine External Interface Specification.

Last edited: 24 August 2021 1:25 pm