Skip to main content
GET
Retrieve a zone

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth/tokens.

Path Parameters

zone_id
string
required

Flatpeak Zone ID.

Response

Zone response.

A network area a VPP operator defines. Read-only: you see the zones that touch your fleet, and only your own devices in them.

id
string
required

Flatpeak Zone ID.

Example:

"zon_9b3c5d7e1f2a4b6c8d0e2f4a"

object
enum<string>
required

Object type, zone.

Available options:
zone
Example:

"zone"

live_mode
boolean
required

true for objects created in live mode.

Example:

true

name
string
required

Zone name, as set by the VPP operator.

Example:

"Bristol constraint zone"

operator_id
string
required

Flatpeak ID of the VPP operator that defined the zone.

Example:

"opr_6a3548352c0d07e89d47b7f1"

definition
object
required
read-only

The zone area: a country, narrowed by states, postal codes or a GeoJSON MultiPolygon. With none of the three, the zone is the whole country.

Example:
device_count
integer | null
required
read-only

Your devices resolved into the zone. Counts cover your account only, never other fleets. null while Flatpeak is still resolving membership, after the VPP operator creates the zone or changes its area.

Example:

128

time_created
string<date-time>
required

Time when the object was created, in UTC.

Example:

"2026-08-12T09:30:00Z"