Geofences

The REST API names geofences as areas. Use archive endpoints for reversible operations and delete endpoints only when you intend to remove records permanently.

GET /areas

GET

List geofences

/areaslinxio.geofences.list(params)

Returns a paginated list of geofence areas.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

number

optional

Number of records per page.

number

optional

Page number to read.

string[]

optional

Optional field projection.

string

optional

Sort expression accepted by Linxio.

Response body fields

LinxioGeofence[]

optional

Geofence records for the current page.

Show child parameters

string | null

optional

Display color.

LatLng[]

optional

Polygon/polyline/rectangle coordinates.

LinxioId

required

Geofence identifier.

string

required

Geofence display name.

number | null

optional

Circle radius when the geofence is circular.

GeofenceType

optional

Geofence shape type.

Possible enum values

circle

Circular geofence.

polygon

Polygon geofence.

polyline

Polyline geofence.

rectangle

Rectangular geofence.

number

optional

Pagination metadata.

Request

curl "https://api.linxio.com/api/areas?limit=100&page=1" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "data": [
    {
      "color": "string",
      "coordinates": [
        {
          "lat": -31.9523,
          "lng": 115.8613
        }
      ],
      "id": 64553,
      "name": "Example",
      "radius": 123,
      "type": "Truck"
    }
  ],
  "page": 1,
  "limit": 100,
  "total": 2
}

GET `/areas/{areaId}`

GET

Get a geofence

/areas/{areaId}linxio.geofences.get(areaId)

Returns one geofence area by ID.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Geofence area identifier.

Response body fields

LinxioId

optional

Geofence area identifier.

string

optional

Geofence display name.

GeofenceType

optional

Geometry type.

Possible enum values

circle

Circular geofence.

polygon

Polygon geofence.

polyline

Polyline geofence.

rectangle

Rectangular geofence.

LatLng[]

optional

Geometry coordinates when supplied.

Show child parameters

number

required

Latitude in decimal degrees.

number

required

Longitude in decimal degrees.

number

optional

Circle radius in metres when supplied.

Request

curl "https://api.linxio.com/api/areas/21" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "id": 64553,
  "name": "Example",
  "type": "Truck",
  "coordinates": [
    {
      "lat": -31.9523,
      "lng": 115.8613
    }
  ],
  "radius": 123
}

POST /areas

POST

Create a geofence

/areaslinxio.geofences.create(payload)

Creates a geofence area.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request body parameters

string

required

Display name.

GeofenceType

required

Geometry type.

Possible enum values

circle

Circular geofence.

polygon

Polygon geofence.

polyline

Polyline geofence.

rectangle

Rectangular geofence.

LatLng[]

optional

Geometry coordinates. Circles typically use one centre point.

Show child parameters

number

required

Latitude in decimal degrees.

number

required

Longitude in decimal degrees.

number

optional

Circle radius in metres.

string

optional

Display colour accepted by Linxio.

Response body fields

LinxioId

optional

Created geofence area ID.

Request

curl -X POST https://api.linxio.com/api/areas \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Temporary SDK Test Area",
    "type": "circle",
    "radius": 150,
    "coordinates": [{ "lat": -31.9505, "lng": 115.8605 }]
  }'

Example response


{
  "id": 64553
}

PATCH `/areas/{areaId}`

PATCH

Update a geofence

/areas/{areaId}linxio.geofences.update(areaId, payload)

Updates a geofence area.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Path and body parameters

LinxioId

required

Geofence area identifier.

Partial<LinxioGeofencePayload>

required

Fields to update.

Show child parameters

string

optional

Display color.

LatLng[]

optional

Polygon/polyline/rectangle coordinates.

string

required

Geofence display name.

number

optional

Circle radius.

GeofenceType

required

Geofence shape type.

Possible enum values

circle

Circular geofence.

polygon

Polygon geofence.

polyline

Polyline geofence.

rectangle

Rectangular geofence.

Response body fields

LinxioId

optional

Updated geofence area ID.

Request

curl -X PATCH https://api.linxio.com/api/areas/21 \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Updated SDK Test Area"
  }'

Example response


{
  "id": 64553
}

PATCH `/areas/{areaId}/archive`

PATCH

Archive a geofence

/areas/{areaId}/archivelinxio.geofences.archive(areaId)

Soft-archives a geofence area.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request url parameters

LinxioId

required

Geofence area identifier.

Response headers

204 or JSON

optional

Successful archive response.

Request

curl -X PATCH https://api.linxio.com/api/areas/21/archive \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Example response


{
  "status": "online"
}

PATCH `/areas/{areaId}/restore`

PATCH

Restore a geofence

/areas/{areaId}/restorelinxio.geofences.restore(areaId)

Restores a previously archived geofence area.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request url parameters

LinxioId

required

Archived geofence area identifier.

Response headers

204 or JSON

optional

Successful restore response.

Request

curl -X PATCH https://api.linxio.com/api/areas/21/restore \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Example response


{
  "status": "online"
}

DELETE `/areas/{areaId}`

DELETE

Delete a geofence

/areas/{areaId}linxio.geofences.delete(areaId)

Permanently deletes a geofence area.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Geofence area identifier.

Response headers

204 or JSON

optional

Successful delete response.

GET /area-groups

GET

List geofence groups

/area-groupslinxio.geofences.listGroups()

Lists area groups.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

void

optional

No query parameters are required.

Response body fields

LinxioId

optional

Area group identifier.

string

optional

Area group display name.

GET `/area-groups/{groupId}`

GET

Get a geofence group

/area-groups/{groupId}linxio.geofences.getGroup(groupId)

Returns one area group by ID.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Area group identifier.

Response body fields

LinxioId

optional

Area group identifier.

string

optional

Area group display name.

POST /area-groups

POST

Create a geofence group

/area-groupslinxio.geofences.createGroup(payload)

Creates an area group.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request body parameters

string

required

Area group display name.

Response body fields

LinxioId

optional

Created area group ID.

Request

curl -X POST https://api.linxio.com/api/area-groups \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Temporary SDK Group"
  }'

Example response


{
  "id": 64553
}

PATCH `/area-groups/{groupId}`

PATCH

Update a geofence group

/area-groups/{groupId}linxio.geofences.updateGroup(groupId, payload)

Updates an area group.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Path and body parameters

LinxioId

required

Area group identifier.

string

optional

Updated group name.

Response body fields

LinxioId

optional

Updated area group ID.

Request

curl -X PATCH https://api.linxio.com/api/area-groups/5 \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Updated SDK Group"
  }'

Example response


{
  "id": 64553
}

PATCH `/area-groups/{groupId}/archive`

PATCH

Archive a geofence group

/area-groups/{groupId}/archivelinxio.geofences.archiveGroup(groupId)

Soft-archives an area group.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request url parameters

LinxioId

required

Area group identifier.

Response headers

204 or JSON

optional

Successful archive response.

Request

curl -X PATCH https://api.linxio.com/api/area-groups/5/archive \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Example response


{
  "status": "online"
}

PATCH `/area-groups/{groupId}/restore`

PATCH

Restore a geofence group

/area-groups/{groupId}/restorelinxio.geofences.restoreGroup(groupId)

Restores a previously archived area group.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request url parameters

LinxioId

required

Archived area group identifier.

Response headers

204 or JSON

optional

Successful restore response.

Request

curl -X PATCH https://api.linxio.com/api/area-groups/5/restore \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Example response


{
  "status": "online"
}

DELETE `/area-groups/{groupId}`

DELETE

Delete a geofence group

/area-groups/{groupId}linxio.geofences.deleteGroup(groupId)

Permanently deletes an area group.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Area group identifier.

Response headers

204 or JSON

optional

Successful delete response.

Geofences

List geofences

Request headers

Request query parameters

Response body fields

Get a geofence

Request headers

Request url parameters

Response body fields

Create a geofence

Request headers

Request body parameters

Response body fields

Update a geofence

Request headers

Path and body parameters

Response body fields

Archive a geofence

Request headers

Request url parameters

Response headers

Restore a geofence

Request headers

Request url parameters

Response headers

Delete a geofence

Request headers

Request url parameters

Response headers

List geofence groups

Request headers

Request query parameters

Response body fields

Get a geofence group

Request headers

Request url parameters

Response body fields

Create a geofence group

Request headers

Request body parameters

Response body fields

Update a geofence group

Request headers

Path and body parameters

Response body fields

Archive a geofence group

Request headers

Request url parameters

Response headers

Restore a geofence group

Request headers

Request url parameters

Response headers

Delete a geofence group

Request headers

Request url parameters

Response headers

On this page