HomeGuidesAPI Reference
API Reference
Status PageHelp CentrePerspio Portal

Get Geofence

get
https://talk.perspio.io/geofences/v3/

Returns a single tenant geofence by id as GeoJSON, hydrated with the assets currently inside it. Scoped to geofences the caller is permitted to see.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Geofence Id

Headers
string

Global data filter (JSON-serialised) scoping results to matching assets. Optional keys, each an array of strings: locationHierarchyL1..L3, productHierarchyL1..L3, operationalHierarchyL1..L3, groupIds; plus boolean 'enabled'. Omit for no additional filtering (security-group scoping always applies). Example: {"locationHierarchyL1":["NSW"],"enabled":true}

boolean

When true, disabled assets are included in the tenant scope applied to this request. Defaults to false.

Responses

401

Invalid API Key provided or Invalid Access token

403

Forbidden. The caller is not permitted to access the requested tenant or geofence, or lacks the required role.

404

Resource Not Found

Updated 6 days ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago

Did this page help you?