Base Operations Saved Locations API
The Saved Locations API from Base Operations — 4 operation(s) for saved locations.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/base-operations-saved-locations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Customer API - Base Operations Saved Locations API
description: Welcome to the Base Operations Customer API!
version: '1.0'
contact: {}
servers:
- url: https://api.baseoperationsenterprise.com/
tags:
- name: Saved Locations
paths:
/v1/public/saved-locations:
post:
description: 'This endpoint allows you to create a new saved location. Creating a saved location here will also be visible in your dashboard.
While only `name`, `latitude`, and `longitude` are required, other parameters will help you organize and analyze your saved locations.
*HINT: The `id` returned from this endpoint will be used as `savedLocationId` in some analysis endpoints*'
operationId: PublicSavedLocationsController_create_v1
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLocationDto'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PublicSavedLocation'
security:
- ApiKey: []
summary: Create Saved Location
tags:
- Saved Locations
get:
description: 'This endpoint allows you to get all saved locations.
You can use the parameters `page`, and `take` to control the pagination, however, there is maximum page size of `take=30`.
If no value is specified for the `take` parameter, the default number of saved locations retrieved is `10`.
You can use `sortBy` to sort your results. This is optional but if provided must be an array of properties you would like to sort by with a suffix of the sort order.
For example `sortBy=name.asc`. If no order is specified the endpoint will default to ascending order.
You can use `visibility` to get your private or public(shared by whole organization) saved locations. This is optional but if provided must be a valid value(public, private).
*HINT: The `id` returned from this endpoint will be used as `savedLocationId` in some analysis endpoints*'
operationId: PublicSavedLocationsController_findAll_v1
parameters:
- name: tags
required: false
in: query
schema:
type: array
items:
type: string
- name: addressTypes
required: false
in: query
schema:
type: array
items:
type: string
enum:
- office
- hotel
- event
- restaurant
- travel
- warehouse
- facility
- parking
- service_area
- point_of_interest
- retail
- airport
- military_base
- other
- name: sortBy
required: false
in: query
description: Sort fields. Some fields may not be available for all organizations.
schema:
example:
- name.asc
- customerLocationId.asc
- addressType.desc
- change.desc
- score.desc
type: array
items:
type: string
- name: visibility
required: false
in: query
schema:
type: string
enum:
- shared
- private
- name: page
required: false
in: query
schema:
minimum: 1
default: 1
type: number
- name: take
required: false
in: query
schema:
minimum: 1
maximum: 50
default: 10
type: number
responses:
'200':
description: Successfully received model list
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PageDto'
- properties:
data:
type: array
items:
$ref: '#/components/schemas/PublicSavedLocation'
security:
- ApiKey: []
summary: Get All Saved Location
tags:
- Saved Locations
/v1/public/saved-locations/tags:
get:
description: This endpoint returns all distinct saved location tags created by the user and their count.
operationId: PublicSavedLocationsController_getSavedLocationTags_v1
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
security:
- ApiKey: []
summary: Get Saved Location Tags
tags:
- Saved Locations
/v1/public/saved-locations/report:
get:
operationId: PublicSavedLocationsController_getSavedLocationReport_v1
parameters:
- name: fromDate
required: false
in: query
schema:
format: date-time
type: string
- name: toDate
required: false
in: query
schema:
format: date-time
type: string
- name: sourceIds
required: false
in: query
schema:
type: array
items:
type: number
- name: months
required: false
in: query
schema:
type: array
items:
type: number
- name: daytimes
required: false
in: query
schema:
type: array
items:
type: string
enum:
- morning
- midmorning
- afternoon
- evening
- night
- name: radius
required: true
in: query
schema:
type: number
- name: units
required: true
in: query
description: 'NB: miles, kilometers and meters will be deprecated soon.'
schema:
type: string
enum:
- mi
- km
- m
- miles
- kilometers
- meters
- name: isGTM
required: false
in: query
schema:
default: true
type: boolean
- name: types
required: false
in: query
schema:
type: array
items:
type: string
enum:
- crime
- unrest
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SavedLocationReport'
text/csv:
schema:
type: string
description: ''
'401':
description: Unauthorized. Your API Key may be invalid or expired.
'500':
description: Internal Server Error
security:
- ApiKey: []
tags:
- Saved Locations
summary: Public saved locations controller get saved location report v1
x-summary-source: derived
/v1/public/saved-locations/{id}:
get:
description: 'This endpoint allows you to get a saved location by it''s `id`.
*HINT: The `id` returned from this endpoint will be used as `savedLocationId` in some analysis endpoints*'
operationId: PublicSavedLocationsController_findOne_v1
parameters:
- name: id
required: true
in: path
schema:
type: number
responses:
'404':
description: Saved location not found
security:
- ApiKey: []
summary: Get Saved Location
tags:
- Saved Locations
put:
description: 'This endpoint allows you to update a saved location. Changes made to a saved location here will also be visible in your dashboard.
*HINT: The `id` returned from this endpoint will be used as `savedLocationId` in some analysis endpoints*'
operationId: PublicSavedLocationsController_update_v1
parameters:
- name: id
required: true
in: path
schema:
type: number
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLocationDto'
responses:
'404':
description: Saved location not found
security:
- ApiKey: []
summary: Update Saved Location
tags:
- Saved Locations
delete:
description: This endpoint allows you to delete a saved location. Changes made to a saved location here will also be visible in your dashboard.
operationId: PublicSavedLocationsController_remove_v1
parameters:
- name: id
required: true
in: path
schema:
type: number
responses:
'200':
description: ''
security:
- ApiKey: []
summary: Delete Saved Location
tags:
- Saved Locations
components:
schemas:
PageDto:
type: object
properties:
data:
type: array
items:
type: array
meta:
$ref: '#/components/schemas/PageMetaDto'
required:
- data
- meta
CreateLocationDto:
type: object
properties:
tags:
maxItems: 15
type: array
items:
type: string
name:
type: string
latitude:
type: number
longitude:
type: number
address:
type: string
addressType:
enum:
- office
- hotel
- event
- restaurant
- travel
- warehouse
- facility
- parking
- service_area
- point_of_interest
- retail
- airport
- military_base
- other
type: string
customerLocationId:
type: string
isPrivate:
type: boolean
radiusMeters:
type: number
required:
- name
- latitude
- longitude
SavedLocationReport:
type: object
properties:
Base Location ID:
type: object
Customer Location ID:
type: string
Location Name:
type: string
Latitude:
type: object
Longitude:
type: object
BaseScore:
type: object
Location Type:
type: string
Dataset From Date:
type: string
Dateset To Date:
type: string
Temporal Granularity:
type: string
All Crime:
type: object
required:
- Base Location ID
- Customer Location ID
- Location Name
- Latitude
- Longitude
- Location Type
- Dataset From Date
- Dateset To Date
- Temporal Granularity
- All Crime
PublicSavedLocation:
type: object
properties:
id:
type: number
customerLocationId:
type: string
name:
type: string
latitude:
type: number
longitude:
type: number
address:
type: string
addressType:
enum:
- office
- hotel
- event
- restaurant
- travel
- warehouse
- facility
- parking
- service_area
- point_of_interest
- retail
- airport
- military_base
- other
type: string
tags:
type: array
items:
$ref: '#/components/schemas/SavedLocationTagsEntity'
isPrivate:
type: boolean
h3IdLvl8:
type:
- string
- 'null'
required:
- id
- name
- latitude
- longitude
- h3IdLvl8
SavedLocationTagsEntity:
type: object
properties:
savedLocationId:
type: number
name:
type: string
required:
- savedLocationId
- name
PageMetaDto:
type: object
properties:
page:
type: number
take:
type: number
itemCount:
type: number
pageCount:
type: number
hasPreviousPage:
type: boolean
hasNextPage:
type: boolean
required:
- page
- take
- itemCount
- pageCount
- hasPreviousPage
- hasNextPage
UpdateLocationDto:
type: object
properties:
tags:
maxItems: 15
type: array
items:
type: string
name:
type: string
latitude:
type: number
longitude:
type: number
address:
type: string
addressType:
enum:
- office
- hotel
- event
- restaurant
- travel
- warehouse
- facility
- parking
- service_area
- point_of_interest
- retail
- airport
- military_base
- other
type: string
customerLocationId:
type: string
isPrivate:
type: boolean
radiusMeters:
type: number
required:
- name
- latitude
- longitude
- address
- addressType
- customerLocationId
- isPrivate
- radiusMeters
securitySchemes:
ApiKey:
type: apiKey
in: header
name: X-API-KEY