Places

Places represent physical locations used across routing, dispatch, contacts, stores, and orders. A place can be a street address, landmark, facility, or any coordinate-backed location Fleetbase can route to.

The Place object

A place represents a physical location used by FleetOps resources such as orders, payloads, vendors, contacts, and waypoints. It stores geocoded coordinates, address fields, ownership, contact details, and metadata.

Attributes

idstringoptional

Public place identifier.

namestringoptional

Display name for the place.

locationobjectoptional

Geospatial coordinates for the place.

addressstringoptional

Formatted address for the place.

avatar_urlstringoptional

Avatar URL associated with the place.

street1stringoptional

Primary street address.

street2stringoptional

Secondary street address.

citystringoptional

City or locality.

provincestringoptional

State, province, or region.

postal_codestringoptional

Postal or ZIP code.

neighborhoodstringoptional

Neighborhood or local area.

districtstringoptional

District or administrative subdivision.

buildingstringoptional

Building name, number, or additional address detail.

security_access_codestringoptional

Access code or delivery instructions needed to enter the building.

countrystringoptional

Country code.

phonestringoptional

Phone number associated with the place.

ownerobjectoptional

Contact or vendor resource that owns the place, when loaded.

tracking_numberobjectoptional

Tracking number associated with the place, when loaded.

typestringoptional

Place classification.

metaobjectoptional

Additional place metadata.

etaobjectoptional

Estimated arrival data when route ETA is requested.

updated_attimestampoptional

Timestamp when the place was last updated.

created_attimestampoptional

Timestamp when the place was created.

The Place object

{
  "id": "place_1A2b3C4d5E",
  "name": "Central Park",
  "location": {
    "latitude": 40.785091,
    "longitude": -73.968285
  },
  "address": "830 5th Ave, New York, NY 10065, USA",
  "avatar_url": null,
  "street1": "830 5th Ave",
  "street2": null,
  "city": "New York",
  "province": "New York",
  "postal_code": "10065",
  "neighborhood": "Manhattan",
  "district": "Midtown",
  "building": "Park Area",
  "security_access_code": null,
  "country": "US",
  "phone": "+12123106600",
  "type": "park",
  "meta": {},
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

POST/v1/places

Create a Place

Creates a place for the current company. Provide structured address fields, a free-form address or street1 value to geocode, or coordinates for Fleetbase to reverse geocode.

Body parameters

namestringoptional

Display name for the place. Required on create unless address, street, or coordinates are enough for Fleetbase to geocode the place.

addressstringoptional

Address string to geocode into a place when structured address fields are not supplied.

street1stringoptional

Primary street address. Required on create unless address or coordinates are supplied.

street2stringoptional

Secondary street address.

citystringoptional

City or locality for the address.

provincestringoptional

State, province, or region for the address.

postal_codestringoptional

Postal or ZIP code for the address.

neighborhoodstringoptional

Neighborhood or local area for the address.

districtstringoptional

District or administrative subdivision for the address.

buildingstringoptional

Building name, number, or additional address detail.

security_access_codestringoptional

Access code or delivery instructions needed to enter the building.

countrystringoptional

Country code for the address.

phonestringoptional

Phone number associated with the place.

locationobjectoptional

Resolvable point used as the place location. Fleetbase accepts supported coordinate formats and reverse geocodes missing address fields.

latitudenumberoptional

Decimal latitude. Required with longitude.

longitudenumberoptional

Decimal longitude. Required with latitude.

ownerstringoptional

Contact or vendor ID that owns the place.

customerstringoptional

Contact or vendor ID to assign as the place owner.

contactstringoptional

Contact or vendor ID to assign as the place owner.

vendorstringoptional

Vendor ID to assign as the place owner.

typestringoptional

Place classification.

metaobjectoptional

Additional place metadata.

POST/v1/places

curl -X POST https://api.fleetbase.io/v1/places \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "name": "Central Park",
  "street1": "830 5th Ave",
  "city": "New York",
  "province": "New York",
  "postal_code": "10065",
  "neighborhood": "Manhattan",
  "district": "Midtown",
  "building": "Park Area",
  "country": "US",
  "phone": "+12123106600",
  "type": "Park"
}'

Other ways to call this

GET/v1/places

Query Places

Searches and filters places for the current organization. Use query and pagination parameters to find matching saved locations.

Query parameters

querystringoptional

Search term matched against place fields.

limitintegeroptional

Maximum number of places to return.

offsetintegeroptional

Number of places to skip before returning results.

sortstringoptional

Sort expression for the place query.

vendorstringoptional

Vendor ID used to filter places owned by a vendor.

GET/v1/places

curl https://api.fleetbase.io/v1/places?query={{place_name}}&limit=25&offset=<string>&sort=created_at \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

GET/v1/places/search

Search Places

Searches places by free-form query and optional lat/lng locale context.

Query parameters

querystringrequired

Free-form search text matched against place name and address fields.

llstringoptional

Latitude/longitude context used to rank or localize search results.

localestringoptional

Locale hint used for place search.

limitintegeroptionalDefault: 10

Maximum number of matching places to return.

geobooleanoptional

When true, enables geospatial search behavior.

latitudenumberoptional

Latitude context for geospatial search.

longitudenumberoptional

Longitude context for geospatial search.

GET/v1/places/search

curl https://api.fleetbase.io/v1/places/search?query={{place_query}}&ll={{place_ll}}&locale={{locale}} \
  -H "Authorization: Bearer flb_live_…"

GET/v1/places

List all Places

Returns a paginated list of places for the current organization. Places are sorted by creation date unless another sort order is provided.

Query parameters

limitintegeroptional

Maximum number of places to return.

offsetintegeroptional

Number of places to skip before returning results.

sortstringoptional

Sort expression for the place list.

GET/v1/places

curl https://api.fleetbase.io/v1/places?limit=25&offset=0&sort=created_at \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

GET/v1/places/:id

Retrieve a Place

This endpoint allows you to retrieve a place object to view it's details.

GET/v1/places/:id

curl https://api.fleetbase.io/v1/places/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

PUT/v1/places/:id

Update a Place

Updates a place by setting the fields included in the request. Send address fields, coordinates, owner assignment, type, phone, or metadata to change only those values.

Body parameters

namestringoptional

Display name for the place.

street1stringoptional

Primary street address.

street2stringoptional

Secondary street address.

citystringoptional

City or locality for the address.

provincestringoptional

State, province, or region for the address.

postal_codestringoptional

Postal or ZIP code for the address.

neighborhoodstringoptional

Neighborhood or local area for the address.

districtstringoptional

District or administrative subdivision for the address.

buildingstringoptional

Building name, number, or additional address detail.

security_access_codestringoptional

Access code or delivery instructions needed to enter the building.

countrystringoptional

Country code for the address.

phonestringoptional

Phone number associated with the place.

locationobjectoptional

Resolvable point used as the place location.

latitudenumberoptional

Decimal latitude. Required with longitude.

longitudenumberoptional

Decimal longitude. Required with latitude.

ownerstringoptional

Contact or vendor ID that owns the place.

vendorstringoptional

Vendor ID to assign as the place owner.

typestringoptional

Place classification.

metaobjectoptional

Additional place metadata.

PUT/v1/places/:id

curl -X PUT https://api.fleetbase.io/v1/places/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "Central Park Edit",
    "street1": "830 5th Ave a ",
    "city": "New York",
    "province": "New York",
    "postal_code": "10065",
    "neighborhood": "Manhattan",
    "district": "Midtown",
    "building": "Park Area",
    "country": "US",
    "phone": "+12123106600",
    "type": "Park"
}'

200 OK

{
  "id": "place_n0voYdE",
  "name": "Central Park Edited",
  "location": {
    "type": "Point",
    "coordinates": [
      -73.9712519,
      40.7676307
    ]
  },
  "address": "CENTRAL PARK EDITED - 830 5TH AVE, NEW YORK, 10065, UNITED STATES",
  "street1": "830 5th Ave",
  "street2": null,
  "city": "New York",
  "province": "New York",
  "postal_code": "10065",
  "neighborhood": "Manhattan",
  "district": "Midtown",
  "building": "Park Area",
  "security_access_code": null,
  "country": "US",
  "phone": null,
  "owner": null,
  "type": "Park",
  "meta": [],
  "updated_at": "2023-12-27T07:43:57.000000Z",
  "created_at": "2023-12-27T07:25:36.000000Z"
}

DELETE/v1/places/:id

Delete a Place

Permanently deletes a place. It cannot be undone.

DELETE/v1/places/:id

curl -X DELETE https://api.fleetbase.io/v1/places/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Accept: application/json"

200 OK

{
  "id": "place_n0voYdE",
  "object": "place",
  "time": "2023-12-27T07:44:36.000000Z",
  "deleted": true
}