Service Areas

Service areas define the geographic regions where a fleet, vendor, or storefront operates. Use service areas to constrain availability, pricing, routing, and dispatch behavior by region.

The Service Area object

A service area defines an operating region. It stores a center point, border geometry, type, status, and optional loaded zones.

Attributes

idstringoptional

Public service area identifier.

namestringoptional

Service area display name.

typestringoptional

Service area type.

centerobjectoptional

Center point for the service area.

borderobjectoptional

Service area border geometry.

zonesarray of objectsoptional

Zones loaded with the service area.

statusstringoptional

Service area status.

updated_attimestampoptional

Timestamp when the service area was last updated.

created_attimestampoptional

Timestamp when the service area was created.

The Service Area object

{
  "id": "service_area_4Mnp8Qx2Vz",
  "name": "Singapore",
  "type": "country",
  "center": {
    "latitude": 1.3521,
    "longitude": 103.8198
  },
  "border": [],
  "zones": [],
  "status": "active",
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

POST/v1/service-areas

Create a Service Area

A service area is created by simply providing a city, province or country in which Fleetbase will reverse geocode into a service area.

If the service area cannot be reverse geocoded, Fleetbase will return an error.

Body parameters

namestringrequired

Service area display name.

countrystringrequired

Country code or country name for the service area.

typestringoptional

Service area type.

statusenumoptional

Service area status. One of active, inactive.

borderobjectoptional

Service area polygon border. Required on create unless a point location or latitude/longitude is supplied.

locationobjectoptional

Resolvable point used to create a circular service area.

latitudenumberoptional

Decimal latitude for a circular service area. Required with longitude.

longitudenumberoptional

Decimal longitude for a circular service area. Required with latitude.

radiusnumberoptionalDefault: 500

Radius in meters when creating a circular service area.

parentstringoptional

Parent service area ID.

colorstringoptional

Fill color used when rendering the service area.

stroke_colorstringoptional

Stroke color used when rendering the service area.

trigger_on_entrybooleanoptional

Whether entering this service area should trigger geofence events.

trigger_on_exitbooleanoptional

Whether exiting this service area should trigger geofence events.

dwell_threshold_minutesintegeroptional

Minutes inside the service area before dwell behavior is triggered.

speed_limit_kmhintegeroptional

Speed limit in kilometers per hour for geofence events.

POST/v1/service-areas

curl -X POST https://api.fleetbase.io/v1/service-areas \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Singapore",
    "type": "city",
    "latitude": "1.3521",
    "longitude": "103.8198",
    "radius": "30000",
    "country": "SG",
    "status": "active"
}'

Other ways to call this

GET/v1/service-areas/:id

Retrieve a Service Area

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

GET/v1/service-areas/:id

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

200 OK

{
  "id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "latitude": "<string>",
  "longitude": "<string>",
  "status": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

GET/v1/service-areas

Query Service Areas

Returns service areas matching the supplied filters. Use this to find configured operating regions by name or other query parameters.

Query parameters

querystringoptional

Search term matched against service area fields.

limitintegeroptional

Maximum number of service areas to return.

offsetintegeroptional

Number of service areas to skip before returning results.

sortstringoptional

Sort expression for the service area query.

countrystringoptional

Filters service areas by country.

GET/v1/service-areas

curl https://api.fleetbase.io/v1/service-areas?name={{service_area_name}} \
  -H "Authorization: Bearer flb_live_…"

PUT/v1/service-areas/:id

Update a Service Area

You are only able to update the service area status

Body parameters

namestringoptional

Service area display name.

countrystringoptional

Country code or country name for the service area.

typestringoptional

Service area type.

statusenumoptional

Service area status. One of active, inactive.

borderobjectoptional

Service area polygon border.

locationobjectoptional

Resolvable point used to create a circular service area.

latitudenumberoptional

Decimal latitude for a circular service area. Required with longitude.

longitudenumberoptional

Decimal longitude for a circular service area. Required with latitude.

radiusnumberoptionalDefault: 500

Radius in meters when updating a circular service area.

parentstringoptional

Parent service area ID.

colorstringoptional

Fill color used when rendering the service area.

stroke_colorstringoptional

Stroke color used when rendering the service area.

trigger_on_entrybooleanoptional

Whether entering this service area should trigger geofence events.

trigger_on_exitbooleanoptional

Whether exiting this service area should trigger geofence events.

dwell_threshold_minutesintegeroptional

Minutes inside the service area before dwell behavior is triggered.

speed_limit_kmhintegeroptional

Speed limit in kilometers per hour for geofence events.

PUT/v1/service-areas/:id

curl -X PUT https://api.fleetbase.io/v1/service-areas/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "status": "active"
}'

200 OK

{
  "id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "latitude": "<string>",
  "longitude": "<string>",
  "status": "<string>",
  "updated_at": "<string>",
  "created_at": "<string>"
}

DELETE/v1/service-areas/:id

Delete a Service Area

Use this endpoint to delete a service area, deleting a service area will also delete all of the zones within the service area.

DELETE/v1/service-areas/:id

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

200 OK

{}