Devices and tracking

Geofences

Geofence management

Fetch a list of Geofences

GET

https://demo.traccar.org/api/geofences

Without params, it returns a list of Geofences the user has access to

Fetch a list of Geofences

curl -X GET 'https://demo.traccar.org/api/geofences' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/geofences', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/geofences',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "area": "string",
    "calendarId": 0,
    "attributes": {}
  }
]

Parameters

allbooleanquery

Can only be used by admins or managers to fetch all entities

userIdintegerquery

Standard users can use this only with their own userId

deviceIdintegerquery

Standard users can use this only with _deviceId_s, they have access to

groupIdintegerquery

Standard users can use this only with _groupId_s, they have access to

refreshbooleanquery

limitintegerquery

Limit the number of returned results

offsetintegerquery

Offset for pagination

keywordstringquery

Search keyword filter

Response

200OKArray<Geofence>

Response fields application/json

Array<Geofence>

Show child attributes

idinteger<int64>

Unique identifier for the geofence

namestring

Human-readable name shown in lists and maps

descriptionstring

Details about the geofence for display in the UI

areastring

Geofence area definition encoded as a WKT string

calendarIdinteger<int64>

Calendar identifier limiting when the geofence is active

attributesobject

Custom key-value pairs for integrations or UI overrides

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Create a Geofence

POST

https://demo.traccar.org/api/geofences

Create a Geofence

curl -X POST 'https://demo.traccar.org/api/geofences' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "name": "string",
  "description": "string",
  "area": "string",
  "calendarId": 0,
  "attributes": {}
}'

const body = `{
  "id": 0,
  "name": "string",
  "description": "string",
  "area": "string",
  "calendarId": 0,
  "attributes": {}
}`;

const response = await fetch('https://demo.traccar.org/api/geofences', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "name": "string",
  "description": "string",
  "area": "string",
  "calendarId": 0,
  "attributes": {}
}'''

response = requests.post(
    'https://demo.traccar.org/api/geofences',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "name": "string",
  "description": "string",
  "area": "string",
  "calendarId": 0,
  "attributes": {}
}

200

{
  "id": 0,
  "name": "string",
  "description": "string",
  "area": "string",
  "calendarId": 0,
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique identifier for the geofence

namestring

Human-readable name shown in lists and maps

descriptionstring

Details about the geofence for display in the UI

areastring

Geofence area definition encoded as a WKT string

calendarIdinteger<int64>

Calendar identifier limiting when the geofence is active

attributesobject

Custom key-value pairs for integrations or UI overrides

Response

200OKGeofence

Response fields application/json

idinteger<int64>

Unique identifier for the geofence

namestring

Human-readable name shown in lists and maps

descriptionstring

Details about the geofence for display in the UI

areastring

Geofence area definition encoded as a WKT string

calendarIdinteger<int64>

Calendar identifier limiting when the geofence is active

attributesobject

Custom key-value pairs for integrations or UI overrides

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch a Geofence

GET

https://demo.traccar.org/api/geofences/{id}

Fetch a Geofence

curl -X GET 'https://demo.traccar.org/api/geofences/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/geofences/0', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/geofences/0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

{
  "id": 0,
  "name": "string",
  "description": "string",
  "area": "string",
  "calendarId": 0,
  "attributes": {}
}

Parameters

idintegerrequiredpath

Response

200OKGeofence

Response fields application/json

idinteger<int64>

Unique identifier for the geofence

namestring

Human-readable name shown in lists and maps

descriptionstring

Details about the geofence for display in the UI

areastring

Geofence area definition encoded as a WKT string

calendarIdinteger<int64>

Calendar identifier limiting when the geofence is active

attributesobject

Custom key-value pairs for integrations or UI overrides

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Update a Geofence

PUT

https://demo.traccar.org/api/geofences/{id}

Update a Geofence

curl -X PUT 'https://demo.traccar.org/api/geofences/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "name": "string",
  "description": "string",
  "area": "string",
  "calendarId": 0,
  "attributes": {}
}'

const body = `{
  "id": 0,
  "name": "string",
  "description": "string",
  "area": "string",
  "calendarId": 0,
  "attributes": {}
}`;

const response = await fetch('https://demo.traccar.org/api/geofences/0', {
  method: 'PUT',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "name": "string",
  "description": "string",
  "area": "string",
  "calendarId": 0,
  "attributes": {}
}'''

response = requests.put(
    'https://demo.traccar.org/api/geofences/0',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "id": 0,
  "name": "string",
  "description": "string",
  "area": "string",
  "calendarId": 0,
  "attributes": {}
}

200

{
  "id": 0,
  "name": "string",
  "description": "string",
  "area": "string",
  "calendarId": 0,
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique identifier for the geofence

namestring

Human-readable name shown in lists and maps

descriptionstring

Details about the geofence for display in the UI

areastring

Geofence area definition encoded as a WKT string

calendarIdinteger<int64>

Calendar identifier limiting when the geofence is active

attributesobject

Custom key-value pairs for integrations or UI overrides

Parameters

idintegerrequiredpath

Response

200OKGeofence

Response fields application/json

idinteger<int64>

Unique identifier for the geofence

namestring

Human-readable name shown in lists and maps

descriptionstring

Details about the geofence for display in the UI

areastring

Geofence area definition encoded as a WKT string

calendarIdinteger<int64>

Calendar identifier limiting when the geofence is active

attributesobject

Custom key-value pairs for integrations or UI overrides

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Delete a Geofence

DELETE

https://demo.traccar.org/api/geofences/{id}

Delete a Geofence

curl -X DELETE 'https://demo.traccar.org/api/geofences/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/geofences/0', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://demo.traccar.org/api/geofences/0',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

Parameters

idintegerrequiredpath

Response

204No Content

No Content

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Docs by Sourcey