Locations

The Locations API provides access to practice locations. Use this to display location information and filter availability by location.

Endpoints

Method	Endpoint	Description
`GET`	`/locations`	List all locations
`GET`	`/locations/{id}`	Retrieve a location

Required scope: read_locations

The Location Object

{
  "id": "loc_123e4567-e89b-12d3-a456-426614174000",
  "name": "Central London Clinic",
  "address_line_1": "123 Harley Street",
  "address_line_2": "Suite 400",
  "city": "London",
  "postcode": "W1G 7JU",
  "country": "United Kingdom",
  "phone": "+44 20 7123 4567",
  "email": "central@clinic.com",
  "is_active": true,
  "created_at": "2023-01-01T00:00:00Z",
  "updated_at": "2024-12-15T10:00:00Z"
}

Attributes

Field	Type	Description
`id`	string	Unique identifier (UUID)
`name`	string	Location name
`address_line_1`	string	Primary address line
`address_line_2`	string	Secondary address line
`city`	string	City
`postcode`	string	Postal code
`country`	string	Country
`phone`	string	Contact phone
`email`	string	Contact email
`is_active`	boolean	Whether location is active
`created_at`	string	ISO 8601 creation timestamp
`updated_at`	string	ISO 8601 last update timestamp

List Locations

GET /locations

Query Parameters

Parameter	Type	Default	Description
`limit`	integer	100	Number of records (max 100)
`offset`	integer	0	Pagination offset

Request

curl -X GET "https://app.usejump.co.uk/functions/v1/api-v1/locations" \
  -H "Authorization: Bearer pk_live_your_api_key"

Response

{
  "data": [
    {
      "id": "loc_123e4567-e89b-12d3-a456-426614174000",
      "name": "Central London Clinic",
      "address_line_1": "123 Harley Street",
      "city": "London",
      "postcode": "W1G 7JU",
      "is_active": true
    },
    {
      "id": "loc_234f5678-e89b-12d3-a456-426614174111",
      "name": "Manchester Clinic",
      "address_line_1": "456 King Street",
      "city": "Manchester",
      "postcode": "M2 4WU",
      "is_active": true
    }
  ],
  "pagination": {
    "total": 2,
    "limit": 100,
    "offset": 0,
    "has_more": false
  }
}

Retrieve a Location

GET /locations/{id}

Request

curl -X GET "https://app.usejump.co.uk/functions/v1/api-v1/locations/loc_123e4567" \
  -H "Authorization: Bearer pk_live_your_api_key"

Response

{
  "data": {
    "id": "loc_123e4567-e89b-12d3-a456-426614174000",
    "name": "Central London Clinic",
    "address_line_1": "123 Harley Street",
    "address_line_2": "Suite 400",
    "city": "London",
    "postcode": "W1G 7JU",
    "country": "United Kingdom",
    "phone": "+44 20 7123 4567",
    "email": "central@clinic.com",
    "is_active": true,
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2024-12-15T10:00:00Z"
  }
}

Related Resources

Availability - Check availability at locations
Appointments - Book at locations
Clinicians - View clinicians

Clinicians Availability