Skip to content
IoT OS

Read a geofence

GET
/integration/v1/organizations/{organization}/geofences/{uuid}
curl --request GET \
  --url https://api.elwids.xyz/api/integration/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/geofences/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Requires: geofences:read

Rate limits: 240 a minute per address, 60 a minute per application

404 when no granted device is assigned to the geofence.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
organization
required
string format: uuid

The organization UUID. A value that does not match returns 404.

uuid
required
string format: uuid

A value that does not match returns 404.

Responses

Section titled “Responses”

200

Section titled “200”

The geofence, with only the granted devices’ assignments.

Media typeapplication/json
object
data
required

A geofence, with only the assignments of devices granted to the application.

object
uuid
required
string format: uuid
name
required
string
geometry
required

A GeoJSON Polygon with one ring of 4 to 257 positions.

object
type
required
Allowed value: Polygon
coordinates
required
Array<Array<array>>
>= 1 items <= 1 items
revision
required
integer
>= 1
created_at
required
string format: date-time
updated_at
required
string format: date-time
assignments
required
Array<object>

One device assigned to the geofence, with its own workflow.

object
uuid
required
string format: uuid
policy
required

When a device counts as wandering outside the geofence.

object
outside_for_seconds
required
integer
<= 86400
max_gap_seconds
required
integer
>= 1 <= 86400
minimum_samples
required
integer
>= 1 <= 1000
uncertainty_metres
required
number
<= 100000
desired_geofence_revision
required
integer
>= 1
applied_geofence_revision
required
integer | null
>= 1
status
required

pending, active, failed or removing.

string
diagnostic
required
string | null
device
required
object
uuid
required
string format: uuid
name
required
string
code
required
string
workflow_uuid
required
string format: uuid
deployment_status
required

The assignment workflow’s deployment status, for example pending, active or inactive.

string

Example 

{
  "data": {
    "uuid": "1e2d3c4b-5a69-4788-9a6b-5c4d3e2f1a0b",
    "name": "North paddock",
    "geometry": {
      "type": "Polygon",
      "coordinates": [
        [
          [
            -114.01,
            50.99
          ],
          [
            -113.99,
            50.99
          ],
          [
            -113.99,
            51.01
          ],
          [
            -114.01,
            51.01
          ],
          [
            -114.01,
            50.99
          ]
        ]
      ]
    },
    "revision": 2,
    "created_at": "2026-10-01T09:00:00.000000Z",
    "updated_at": "2026-10-12T08:00:00.000000Z",
    "assignments": []
  }
}

Headers

Section titled “Headers”
Cache-Control
required
string
/(^|[ ,])no-store([ ,]|$)/

Responses to authenticated integration requests are never cached. The header also carries private.

Example 
no-store, private

401

Section titled “401”

No valid credentials: no session (first-party API), or a missing, invalid, expired or revoked application token (integration API).

Media typeapplication/json

The body of most error responses.

object
message
required
string

Example generated

{
  "message": "example"
}

403

Section titled “403”

The caller is not allowed: not a member of the organization, missing a tenant or platform permission, or (integration API) an ability not granted on both the application and the token.

Media typeapplication/json

The body of most error responses.

object
message
required
string

Example generated

{
  "message": "example"
}

404

Section titled “404”

Not found: an unknown organization or resource, a resource in another organization or not granted to the application, or a malformed identifier (the route does not match).

Media typeapplication/json

The body of most error responses.

object
message
required
string

Example generated

{
  "message": "example"
}

429

Section titled “429”

A rate limit was reached; see x-rate-limits on the operation.

Media typeapplication/json

The body of most error responses.

object
message
required
string

Example generated

{
  "message": "example"
}

Headers

Section titled “Headers”
Retry-After
required
integer

Seconds to wait before retrying.

Report a problem with this page