Location

Service to communicate with locations.

Endpoints

GET /location/v1/locations Get locations GET /location/v1/locations/{id} Get location PATCH /location/v1/locations/{id} Update location GET /location/v1/public-areas/{public_area_id}/locations Get public area locations
GET /location/v1/locations
Authenticated

Get locations

Query Parameters

NameTypeRequiredDescription
radius string No Limit the result of returned locations by given radius. Ignored if lat_lng is not present. https://en.wikipedia.org/wiki/Geographical_distance#Spherical_Earth_projected_to_a_plane
include string No Include additional data in the response. Supported values: resources
tag string No Filter by location tag. Can be used as multiple value query param.
lat_lng string No Filter locations by given latitude and longitude. For example lat_lng=59.4098187,24.7322463

Responses

200 response

data [object]
code string
owner_id string

Restricted field, requires additional permissions

operator_id string

Restricted field, requires additional permissions

support_phone string

Support phone number for this location

latitude number
icon object
description string

Restricted field, requires additional permissions

type string BIKE_DOCKS BIKE_LOCKERS BIKE_HOUSE BIKE_HOUSE_DOCKLESS BIKE_HANGAR SCOOTER_DOCKS SCOOTER_DOCKS_V2 BIKE_RENTALS BIKE_RENTALS_SESSIONLESS SCOOTER_RENTALS

BIKE_RENTALS and SCOOTER_RENTALS are deprecated.

has_maintenance_issues boolean

Restricted field, requires additional permissions

terms_url string

Terms and conditions for the usage of this location

audit object

Restricted field, requires additional permissions

connection string onlinepartially_onlineofflineunknown
id string
has_access_lists boolean
reseller_id string

Restricted field, requires additional permissions

longitude number
address string
offline_since string

RFC3339 timestamp or empty string

rental_devices object deprecated

Deprecated: will be removed in a future version

devices object
label string
uri string
tags [string]

Public tags, displayed to everyone

support_email string

Support email address for this location

allowlisted boolean
distributor_id string

Restricted field, requires additional permissions

name string

Convenience field, combines code and label

comment string

Restricted field, requires additional permissions

private_tags [string]

Restricted field, requires additional permissions

status string IN_HOUSE DEMO IN_DELIVERY INSTALLED LAUNCHED_OFFLINE LAUNCHED MAINTENANCE OBSOLETE
uri string

Example Request

curl \
  "https://services.bikeep.com/location/v1/locations" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"
GET /location/v1/locations/{id}
Authenticated

Get location

Path Parameters

NameTypeDescription
id string Location id required

Query Parameters

NameTypeRequiredDescription
include string No Include additional data in the response. Supported values: resources

Responses

200 response

subscriptions object
uri string

Subscriptions available in the location

owner_id string

Restricted field, requires additional permissions

operator_id string

Restricted field, requires additional permissions

support_phone string

Support phone number for this location

type string BIKE_DOCKS BIKE_LOCKERS BIKE_HOUSE BIKE_HOUSE_DOCKLESS BIKE_HANGAR SCOOTER_DOCKS SCOOTER_DOCKS_V2 BIKE_RENTALS BIKE_RENTALS_SESSIONLESS SCOOTER_RENTALS

BIKE_RENTALS and SCOOTER_RENTALS are deprecated.

descriptions object
uri string

Additional location descriptions

access_list_ids [string]

Access list IDs active in this location

allowlist_ids [string]

Allowlist IDs active in this location

rfid_parking boolean
free_parking_details string

More detailed info about free parking in this location

segment string
whitelists object
uri string

Whitelists the location is in

app_parking boolean
connection string onlinepartially_onlineofflineunknown
id string
state string
reseller_id string

Restricted field, requires additional permissions

longitude number
generation string

Restricted field, requires additional permissions

offline_since string

RFC3339 timestamp or empty string

devices object
total number

Number of total locking devices in location

available number

Number of available locking devices to use

icon object deprecated

Deprecated: use icon on location root instead

online number

Number of online locking devices

resources [object]

Detailed overview of location device resources, to determine which are online/available, included in response when querying with ‘include=resources’ param value

uri string
free_parking_summary string

Brief info about free parking in this location

terms_updated_at string

Timestamp of the terms and conditions last update (RFC3339 timestamp)

tags [string]

Public tags, displayed to everyone

allowlisted boolean
district string
distributor_id string

Restricted field, requires additional permissions

name string

Convenience field, combines code and label

region string
status string IN_HOUSE DEMO IN_DELIVERY INSTALLED LAUNCHED_OFFLINE LAUNCHED MAINTENANCE OBSOLETE
code string
city string
latitude number
icon object
png2x string deprecated

Deprecated: use type instead

svg string deprecated

Deprecated: use type instead

png string deprecated

Deprecated: use type instead

type string

Icon family ID, to be used with local/external assets

description string

Restricted field, requires additional permissions

has_maintenance_issues boolean

Restricted field, requires additional permissions

booking_available boolean
terms_url string

Terms and conditions for the usage of this location

audit object

Restricted field, requires additional permissions

external_devices object
uri string

Non-Bikeep devices used in the location

has_access_lists boolean
address string
rental_devices object deprecated

Deprecated: will be removed in a future version

available number deprecated

Deprecated: will be removed in a future version. Number of available rental devices to rent

icon object deprecated

Deprecated: use icon on location root instead

uri string deprecated

Deprecated: will be removed in a future version

auto_restarts_enabled boolean

Restricted field, requires additional permissions

label string
uri string
power_save_strategy string

Restricted field, requires additional permissions

free_parking_hours number

How many hours is one allowed to use this location for free parking

use_case string
analytics_dashboard_id string

Restricted field, requires additional permissions

e_charging boolean
support_email string

Support email address for this location

max_user_sessions number

Maximum number of concurrent parking sessions allowed in the location

organizations object
uri string deprecated

Deprecated: use owner, operator, reseller and distributor IDs instead

comment string

Restricted field, requires additional permissions

private_tags [string]

Restricted field, requires additional permissions

free_of_charge boolean

Example Request

curl \
  "https://services.bikeep.com/location/v1/locations/{ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"
PATCH /location/v1/locations/{id}
Authenticated

Update location

Path Parameters

NameTypeDescription
id string Location id required

Request Body required

code string
city string
owner_id string

Requires organization management permissions

operator_id string

Requires organization management permissions

support_phone string

Requires superadmin permissions

latitude number
description string

Requires superadmin permissions

type string

Requires superadmin permissions

rfid_parking boolean
free_parking_details string

Restricted field, requires additional permissions

terms_url string

Requires superadmin permissions

booking_available boolean
segment string
app_parking boolean
state string
reseller_id string

Requires organization management permissions

longitude number
icon_type string

Requires superadmin permissions

generation string

Requires superadmin permissions

address string
free_parking_summary string

Restricted field, requires additional permissions

auto_restarts_enabled boolean

Requires superadmin permissions

label string
power_save_strategy string

Requires superadmin permissions

free_parking_hours number
use_case string

Requires superadmin permissions

public_tags object

Requires public tag management permissions

add [string]
remove [string]
support_email string

Requires superadmin permissions

e_charging boolean
max_user_sessions number

Requires superadmin permissions

district string
distributor_id string

Requires organization management permissions

comment string

Restricted field, requires additional permissions

region string

Requires superadmin permissions

private_tags object

Requires private tag permissions

add [string]
remove [string]
free_of_charge boolean

Responses

204 response

Example Request

curl \
  -X PATCH \
  "https://services.bikeep.com/location/v1/locations/{ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "string",
  "city": "string",
  "owner_id": "00000000-0000-0000-0000-000000000000",
  "operator_id": "00000000-0000-0000-0000-000000000000",
  "support_phone": "+372 5555 5555",
  "latitude": 59.437,
  "description": "string",
  "type": "string",
  "rfid_parking": true,
  "free_parking_details": "string",
  "terms_url": "https://example.com/resource",
  "booking_available": true,
  "segment": "string",
  "app_parking": true,
  "state": "string",
  "reseller_id": "00000000-0000-0000-0000-000000000000",
  "longitude": 24.7536,
  "icon_type": "string",
  "generation": "string",
  "address": "string",
  "free_parking_summary": "string",
  "auto_restarts_enabled": true,
  "label": "string",
  "power_save_strategy": "string",
  "free_parking_hours": 0,
  "use_case": "string",
  "public_tags": {
    "add": [
      "string"
    ],
    "remove": [
      "string"
    ]
  },
  "support_email": "user@example.com",
  "e_charging": true,
  "max_user_sessions": 0,
  "district": "string",
  "distributor_id": "00000000-0000-0000-0000-000000000000",
  "comment": "string",
  "region": "string",
  "private_tags": {
    "add": [
      "string"
    ],
    "remove": [
      "string"
    ]
  },
  "free_of_charge": true
}'
GET /location/v1/public-areas/{public_area_id}/locations
Public

Get public area locations

No authorization required

Public area consists of selected locations grouped under a public area ID. Querying public area locations are for users who want to add Bikeep locations on/in their websites/apps. Since there is no authorization required, it is the fastest and easiest way to display Bikeep locations. Public areas are created and managed by Bikeep, let us know if you need one. The response is in GeoJSON format (https://geojson.org)

Path Parameters

NameTypeDescription
public_area_id string Public area ID required

Responses

200 response

features [object]
geometry object
type string Feature
properties object
type string FeatureCollection

Example Request

curl \
  "https://services.bikeep.com/location/v1/public-areas/{PUBLIC_AREA_ID}/locations"