Fleet setup

Groups

Group management

Fetch a list of Groups

GET

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

Without any params, returns a list of the Groups the user belongs to

Fetch a list of Groups

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

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

const data = await response.text();

import requests

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

200

[
  {
    "id": 0,
    "name": "string",
    "groupId": 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

limitintegerquery

Limit the number of returned results

offsetintegerquery

Offset for pagination

keywordstringquery

Search keyword filter

Response

200OKArray<Group>

Response fields application/json

Array<Group>

Show child attributes

idinteger<int64>

Unique group identifier

namestring

Group display name

groupIdinteger<int64>

Parent group identifier for nested grouping

attributesobject

Arbitrary metadata attached to the group

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Create a Group

POST

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

Create a Group

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

const body = `{
  "id": 0,
  "name": "string",
  "groupId": 0,
  "attributes": {}
}`;

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

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "name": "string",
  "groupId": 0,
  "attributes": {}
}'''

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

Request Body

{
  "id": 0,
  "name": "string",
  "groupId": 0,
  "attributes": {}
}

200

{
  "id": 0,
  "name": "string",
  "groupId": 0,
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique group identifier

namestring

Group display name

groupIdinteger<int64>

Parent group identifier for nested grouping

attributesobject

Arbitrary metadata attached to the group

Response

200OKGroup

Response fields application/json

idinteger<int64>

Unique group identifier

namestring

Group display name

groupIdinteger<int64>

Parent group identifier for nested grouping

attributesobject

Arbitrary metadata attached to the group

400Bad Request

No permission

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Fetch a Group

GET

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

Fetch a Group

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

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

const data = await response.text();

import requests

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

200

{
  "id": 0,
  "name": "string",
  "groupId": 0,
  "attributes": {}
}

Parameters

idintegerrequiredpath

Response

200OKGroup

Response fields application/json

idinteger<int64>

Unique group identifier

namestring

Group display name

groupIdinteger<int64>

Parent group identifier for nested grouping

attributesobject

Arbitrary metadata attached to the group

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Update a Group

PUT

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

Update a Group

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

const body = `{
  "id": 0,
  "name": "string",
  "groupId": 0,
  "attributes": {}
}`;

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

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "name": "string",
  "groupId": 0,
  "attributes": {}
}'''

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

Request Body

{
  "id": 0,
  "name": "string",
  "groupId": 0,
  "attributes": {}
}

200

{
  "id": 0,
  "name": "string",
  "groupId": 0,
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique group identifier

namestring

Group display name

groupIdinteger<int64>

Parent group identifier for nested grouping

attributesobject

Arbitrary metadata attached to the group

Parameters

idintegerrequiredpath

Response

200OKGroup

Response fields application/json

idinteger<int64>

Unique group identifier

namestring

Group display name

groupIdinteger<int64>

Parent group identifier for nested grouping

attributesobject

Arbitrary metadata attached to the group

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Delete a Group

DELETE

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

Delete a Group

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

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

const data = await response.text();

import requests

response = requests.delete(
    'https://demo.traccar.org/api/groups/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