Skip to main content
POST
/nhs/services/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
service_type
enum<string>
required
Available options:
gp,
dentist,
pharmacy,
hospital,
nhs_sight_test,
podiatrist,
sexual_health_clinic,
hiv_treatment,
breast_screening,
abdominal_aortic_aneurysm_screening,
diabetic_eye_screening,
chlamydia_screening,
sti_testing,
emergency_contraception,
free_condoms,
sexual_health_advice,
young_people_sexual_health,
rape_and_sexual_assault_referral,
drug_treatment,
drug_addiction_support,
stop_smoking,
pals,
pregnancy_testing
postcode
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
filters
enum<string>[] | null
Available options:
GpAcceptingNewPatients,
GpAcceptingOutOfAreaPatients,
PharmacyOpenNow,
ConsultationRoom,
CarParking,
DisabledCarParking,
StepFreeAccess,
WheelchairAccess,
DentistAcceptingChildren,
DentistAcceptingAdults,
DentistAcceptingFreeCare

Response

Successful Response

id
string
required
name
string
required
@type
string
default:NhsServiceSearchItem
org_type_code
string | null
address
string | null
phone
string | null
distance_miles
number | null
status
string[]
registration_url
string | null
detail_url
string | null