DevelopersReturn to site
API Reference

Locations

Query practice locations with the Jump EHR Locations API. Read-only access to addresses, opening hours, and geo-coordinates.

The Locations API provides read-only access to practice locations (branch surgeries). Locations are referenced by appointments, clinician profiles, and availability slots.

GET
/locations

Authorization

BearerApiKey
AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Query Parameters

limit?integer

Maximum number of records to return (1–100, default 20)

Range1 <= value <= 100
Default20
offset?integer

Number of records to skip (default 0)

Range0 <= value
Default0
is_active?boolean
search?string

Full-text search across name, postcode, and town_city

Response Body

application/json

curl -X GET "https://example.com/locations"
{  "data": [    {      "id": "string",      "name": "string",      "address_line_1": "string",      "address_line_2": "string",      "address_line_3": "string",      "town_city": "string",      "postcode": "string",      "country": "string",      "phone": "string",      "email": "string",      "lat": 0,      "lng": 0,      "timezone": "string",      "opening_hours": {},      "is_primary": true,      "is_active": true,      "created_at": "string",      "updated_at": "string"    }  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/locations/{id}

Authorization

BearerApiKey
AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.com/locations/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "id": "string",    "name": "string",    "address_line_1": "string",    "address_line_2": "string",    "address_line_3": "string",    "town_city": "string",    "postcode": "string",    "country": "string",    "phone": "string",    "email": "string",    "lat": 0,    "lng": 0,    "timezone": "string",    "opening_hours": {},    "is_primary": true,    "is_active": true,    "created_at": "string",    "updated_at": "string"  },  "meta": {    "request_id": "req_abc123"  }}