Zones

Zone management

List all zones

get
Query parameters
searchstringOptional
categoryIdsstringOptional

Comma-separated category IDs

Responses
200

List of zones

application/json
idintegerOptional
titlestringOptional
descriptionstring · nullableOptional
geojsonobjectOptional
userIdstring · nullableOptional
isGlobalbooleanOptional
map3dTypestring · nullableOptional
map3dUrlstring · nullableOptional
map3dConfigobject · nullableOptional
previewImageUrlstring · nullableOptional
areanumber · nullableOptional
blockchainSignaturestring · nullableOptional
blockchainTxUrlstring · nullableOptional
blockchainSyncedAtstring · date-time · nullableOptional
blockchainSyncStatusstring · enumOptionalPossible values:
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
get
/zones

Create a new zone

post
Body
titlestringRequired
descriptionstringOptional
geojsonobjectRequired
categoryIdsinteger[]Optional
map3dTypestring · nullableOptional
map3dUrlstring · nullableOptional
map3dConfigobject · nullableOptional
Responses
post
/zones

Get zones owned by authenticated user

get

Fetches all zones owned by the currently authenticated user, ordered by creation date (newest first).

Authorizations
AuthorizationstringRequired

Bearer token authentication. Pass the session token obtained from /auth/sync.

Responses
200

List of user's zones

application/json
idintegerOptional
titlestringOptional
descriptionstring · nullableOptional
geojsonobjectOptional
userIdstring · nullableOptional
isGlobalbooleanOptional
map3dTypestring · nullableOptional
map3dUrlstring · nullableOptional
map3dConfigobject · nullableOptional
previewImageUrlstring · nullableOptional
areanumber · nullableOptional
blockchainSignaturestring · nullableOptional
blockchainTxUrlstring · nullableOptional
blockchainSyncedAtstring · date-time · nullableOptional
blockchainSyncStatusstring · enumOptionalPossible values:
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
get
/zones/mine

Get a zone by ID

get
Path parameters
idintegerRequired

Zone ID

Responses
200

Zone details

application/json
idintegerOptional
titlestringOptional
descriptionstring · nullableOptional
geojsonobjectOptional
userIdstring · nullableOptional
isGlobalbooleanOptional
map3dTypestring · nullableOptional
map3dUrlstring · nullableOptional
map3dConfigobject · nullableOptional
previewImageUrlstring · nullableOptional
areanumber · nullableOptional
blockchainSignaturestring · nullableOptional
blockchainTxUrlstring · nullableOptional
blockchainSyncedAtstring · date-time · nullableOptional
blockchainSyncStatusstring · enumOptionalPossible values:
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
get
/zones/{id}

Update a zone

put
Path parameters
idintegerRequired
Body
titlestringRequired
descriptionstringOptional
geojsonobjectOptional
categoryIdsinteger[]Optional
map3dTypestring · nullableOptional
map3dUrlstring · nullableOptional
map3dConfigobject · nullableOptional
Responses
200

Zone updated

application/json
idintegerOptional
titlestringOptional
descriptionstring · nullableOptional
geojsonobjectOptional
userIdstring · nullableOptional
isGlobalbooleanOptional
map3dTypestring · nullableOptional
map3dUrlstring · nullableOptional
map3dConfigobject · nullableOptional
previewImageUrlstring · nullableOptional
areanumber · nullableOptional
blockchainSignaturestring · nullableOptional
blockchainTxUrlstring · nullableOptional
blockchainSyncedAtstring · date-time · nullableOptional
blockchainSyncStatusstring · enumOptionalPossible values:
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
put
/zones/{id}

Delete a zone

delete
Path parameters
idintegerRequired
Responses
delete
/zones/{id}

No content

Get blockchain status for a zone

get

Retrieves the blockchain sync status, transaction signature, explorer URL, and transaction history for a specific zone. Authentication required.

Authorizations
X-Dynamic-User-IdstringRequired

Dynamic authentication header. Required for blockchain endpoints and other authenticated operations.

Path parameters
idintegerRequired

Zone ID

Responses
200

Blockchain status retrieved successfully

application/json
get
/zones/{id}/blockchain

Get pins for a zone

get
Path parameters
idintegerRequired
Responses
200

List of pins in zone

application/json
idintegerOptional
titlestringOptional
latitudenumber · nullableOptional
longitudenumber · nullableOptional
geoPoseobjectOptional

JSON object containing geographic position and orientation data

contentTypestring · enumOptionalPossible values:
contentUrlstringOptional
zoneIdinteger · nullableOptional
gcpIdinteger · nullableOptional
userIdstring · nullableOptional
visibilitystring · enumOptional

Pin visibility setting

Possible values:
relocalizationPhotoUrlstring · nullableOptional

URL of the relocalization reference photo

scanInstructionsstring · nullableOptional

Instructions for scanning/relocalizing

cameraPoseHintobject · nullableOptional

Camera pose hint for AR relocalization

blockchainSignaturestring · nullableOptional
blockchainTxUrlstring · nullableOptional
blockchainSyncedAtstring · date-time · nullableOptional
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
get
/zones/{id}/pins

Create a pin in a zone

post
Path parameters
idintegerRequired
Body
titlestringRequired
contentUrlstring · uriRequired
contentTypestring · enumRequiredPossible values:
gcpDatastringOptional
gcpTypestring · enumOptionalPossible values:
altitudenumberOptional
aprilTagIdinteger · max: 50Optional
photoUrlsstring · uri[] · max: 3Optional
Responses
post
/zones/{id}/pins

Create a GCP in a zone

post
Path parameters
idintegerRequired
Body
titlestringRequired
descriptionstringOptional
gcpTypestring · enumRequiredPossible values:
altitudenumberOptional
aprilTagIdinteger · max: 50Optional
gcpDatastringOptional
photoUrlsstring · uri[] · max: 3Optional
uploadedFileIdsinteger[]Optional
zoneIdintegerOptional
Responses
post
/zones/{id}/gcp

Check April tag availability in a zone

get
Path parameters
idintegerRequired
Query parameters
aprilTagIdinteger · max: 50Required
latitudenumberOptional
longitudenumberOptional
excludeGcpIdintegerOptional
Responses
200

April tag validation result

application/json
availablebooleanOptional
conflictsobject[]Optional
get
/zones/{id}/gcp/check-april-tag

Get the global zone

get
Responses
200

Global zone

application/json
idintegerOptional
titlestringOptional
descriptionstring · nullableOptional
geojsonobjectOptional
userIdstring · nullableOptional
isGlobalbooleanOptional
map3dTypestring · nullableOptional
map3dUrlstring · nullableOptional
map3dConfigobject · nullableOptional
previewImageUrlstring · nullableOptional
areanumber · nullableOptional
blockchainSignaturestring · nullableOptional
blockchainTxUrlstring · nullableOptional
blockchainSyncedAtstring · date-time · nullableOptional
blockchainSyncStatusstring · enumOptionalPossible values:
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
get
/zones/global-zone

Last updated