---
title: "Read the currently loaded zone set"
method: GET
path: "/v1/vehicles/{vehicleId}/loaded-zone-set"
tags: ["Zone Set Management"]
---

# Read the currently loaded zone set

`GET /v1/vehicles/{vehicleId}/loaded-zone-set`

## Request

- Base URL: `https://api.polymathrobotics.dev`
- URL: `https://api.polymathrobotics.dev/v1/vehicles/{vehicleId}/loaded-zone-set`
- Auth: HTTP bearer

## Path parameters

- `vehicleId` string, required

## Response `200`

Successful Response

- ReadZoneSetResponse
  - `status` 'success': JSend status.
  - `message` string, required: Human-readable message.
  - `zone_set` ZoneSet, required
    - `name` string, required: Name of the zone set.
    - `zones` ZoneInfo[], required: Zones in the set.
      - `name` string, required: Name of the zone, unique within the set.
      - `type` 'speed_limit' | 'geofence' | 'keep_out' | 'stop_zone' | 'flag_zone', required: An enumeration.
      - `enabled` boolean: Whether the zone is enabled. Sent on write; returned on a stored read. Not the loaded-set runtime state.
      - `coordinate_system` 0 | 1: An enumeration.
      - `wgs84_polygon` ZoneGeoPoint[]: Boundary vertices in WGS84. Required when coordinate_system is WGS84.
        - `latitude` number, required: Latitude
        - `longitude` number, required: Longitude
      - `map_polygon` MapPoint[]: Boundary vertices in the map frame. Required when coordinate_system is MAP.
        - `x` number, required: X position in the map frame (meters).
        - `y` number, required: Y position in the map frame (meters).
      - `condition` ZoneConditionInfo: Base for request bodies: unknown fields are rejected instead of silently dropped.
        - `type` 0: An enumeration.
        - `params` KeyValuePair[]: Condition parameters.
          - `key` string, required
          - `value` string, required
      - `params` KeyValuePair[]: Zone parameters.
        - `key` string, required
        - `value` string, required
      - `state` 0 | 1 | 2 | 3: An enumeration.

## Other responses

- `404`: No zone set is currently loaded
- `500`: Internal server error

## Changes

- **2026-11-03** `3b5ff2f21338`: 1 warning
  - added the new `flag_zone` enum value to the `zone_set/allOf[subschema #1: ZoneSet]/zones/items/type/allOf[subschema #1: ZoneType]/` response property for the response status `200`
- **2026-10-09** `ef34405d1b54`: 1 warning
  - added the new `stop_zone` enum value to the `zone_set/allOf[subschema #1: ZoneSet]/zones/items/type/allOf[subschema #1: ZoneType]/` response property for the response status `200`
- **2026-09-09** `7bb062ddb622`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/polymathrobotics/apis/polymath-api/changes/v1/vehicles/:vehicleId/loaded-zone-set/get.md)

---

[API](https://skmtc.dev/polymathrobotics/apis/polymath-api.md) - [All operations](https://skmtc.dev/polymathrobotics/apis/polymath-api/llms.txt) - [OpenAPI document](https://skmtc.dev/polymathrobotics/apis/polymath-api/revisions/3b5ff2f21338?raw)