Get NHS contract by ID

Request

Returns the single NHS contract matching id for the practice identified by X-Practice-Id. The identifier is the same id returned when listing NHS contracts.

If no NHS contract exists for that practice and id, the API responds with 404.

Security

oauth2(Required scopes: nhs:contract:read)

Path

idstring, (uuid)required

Resource identifier to filter/find.

X-Practice-Idstring, (uuid)required

UUID of the practice in whose context the request is executed. The API uses this to resolve data the caller is permitted to access for that practice.

curl -i -X GET \
  'https://docs.api.dentally.com/_mock/docs/versions/2026-01-01/nexgen/nhs/contracts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Practice-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Full details for one NHS contract.

Bodyapplication/json

dataobject(nhs-contract)required

An NHS dental service contract configured for a practice.

Response

An NHS contract configured for the practice.

{
  "data": {
    "id": "74299a51-bb9a-47eb-9524-20ec9c3958a8",
    "name": "Main Surgery NHS Contract",
    "is_active": true,
    "site_id": "a11df716-ce65-4210-be87-8b8ec448f85c",
    "nhs_contract_number": "1234567890",
    "nhs_site_id": "12345",
    "nhs_location_id": "200006",
    "start_date": "2025-04-01",
    "end_date": null,
    "is_pds_plus": false,
    "notes": null,
    "created_at": "2025-01-10T09:00:00Z",
    "updated_at": "2026-08-20T11:20:00Z"
  }
}