Users and access

Users

User management

Fetch a list of Users

GET

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

Fetch a list of Users

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

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

const data = await response.text();

import requests

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

200

[
  {
    "id": 0,
    "name": "string",
    "email": "string",
    "phone": "string",
    "readonly": true,
    "administrator": true,
    "map": "string",
    "latitude": 0,
    "longitude": 0,
    "zoom": 0,
    "password": "string",
    "coordinateFormat": "string",
    "disabled": true,
    "expirationTime": "2024-01-15T09:30:00Z",
    "deviceLimit": 0,
    "userLimit": 0,
    "deviceReadonly": true,
    "limitCommands": true,
    "fixedEmail": true,
    "poiLayer": "string",
    "attributes": {}
  }
]

Parameters

userIdstringquery

Can only be used by admin or manager users

limitintegerquery

Limit the number of returned results

offsetintegerquery

Offset for pagination

keywordstringquery

Search keyword filter (searches name, email)

Response

200OKArray<User>

Response fields application/json

Array<User>

Show child attributes

idinteger<int64>

Unique user identifier

namestring

User display name

emailstring

Email address used for login and notifications

phonestring | null

Contact phone number for alerts

readonlyboolean

When true, the user cannot change settings

administratorboolean

Grants full administrative privileges when enabled

mapstring | null

Preferred default map layer for the user

latitudenumber

Default map center latitude for this user

longitudenumber

Default map center longitude for this user

zoominteger

Default map zoom level on login

passwordstring

Password for user authentication

coordinateFormatstring | null

Preferred coordinate display format

disabledboolean

Indicates whether the user account is disabled

expirationTimestring<date-time> | null

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

deviceLimitinteger

Maximum number of devices the user can manage

userLimitinteger

Maximum number of subordinate users

deviceReadonlyboolean

Restricts user from modifying device attributes

limitCommandsboolean

Prevents user from sending unsupported commands

fixedEmailboolean

Locks the email field to avoid changes

poiLayerstring | null

External POI layer configured for the user

attributesobject

Additional custom user attributes

400Bad Request

No Permission

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Create a User

POST

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

Create a User

curl -X POST 'https://demo.traccar.org/api/users' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}'

const body = `{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}`;

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

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}'''

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

Request Body

{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

200

{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique user identifier

namestring

User display name

emailstring

Email address used for login and notifications

phonestring | null

Contact phone number for alerts

readonlyboolean

When true, the user cannot change settings

administratorboolean

Grants full administrative privileges when enabled

mapstring | null

Preferred default map layer for the user

latitudenumber

Default map center latitude for this user

longitudenumber

Default map center longitude for this user

zoominteger

Default map zoom level on login

passwordstring

Password for user authentication

coordinateFormatstring | null

Preferred coordinate display format

disabledboolean

Indicates whether the user account is disabled

expirationTimestring<date-time> | null

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

deviceLimitinteger

Maximum number of devices the user can manage

userLimitinteger

Maximum number of subordinate users

deviceReadonlyboolean

Restricts user from modifying device attributes

limitCommandsboolean

Prevents user from sending unsupported commands

fixedEmailboolean

Locks the email field to avoid changes

poiLayerstring | null

External POI layer configured for the user

attributesobject

Additional custom user attributes

Response

200OKUser

Response fields application/json

idinteger<int64>

Unique user identifier

namestring

User display name

emailstring

Email address used for login and notifications

phonestring | null

Contact phone number for alerts

readonlyboolean

When true, the user cannot change settings

administratorboolean

Grants full administrative privileges when enabled

mapstring | null

Preferred default map layer for the user

latitudenumber

Default map center latitude for this user

longitudenumber

Default map center longitude for this user

zoominteger

Default map zoom level on login

passwordstring

Password for user authentication

coordinateFormatstring | null

Preferred coordinate display format

disabledboolean

Indicates whether the user account is disabled

expirationTimestring<date-time> | null

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

deviceLimitinteger

Maximum number of devices the user can manage

userLimitinteger

Maximum number of subordinate users

deviceReadonlyboolean

Restricts user from modifying device attributes

limitCommandsboolean

Prevents user from sending unsupported commands

fixedEmailboolean

Locks the email field to avoid changes

poiLayerstring | null

External POI layer configured for the user

attributesobject

Additional custom user attributes

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Generate TOTP secret

POST

https://demo.traccar.org/api/users/totp

Generate TOTP secret

curl -X POST 'https://demo.traccar.org/api/users/totp'

const response = await fetch('https://demo.traccar.org/api/users/totp', {
  method: 'POST',
});

const data = await response.text();

import requests

response = requests.post('https://demo.traccar.org/api/users/totp')
print(response.text)

200

string

Response

200OKstring

Response fields text/plain

string

400Bad Request

Bad request

Fetch a User

GET

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

Fetch a User

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

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

const data = await response.text();

import requests

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

200

{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

Parameters

idintegerrequiredpath

Response

200OKUser

Response fields application/json

idinteger<int64>

Unique user identifier

namestring

User display name

emailstring

Email address used for login and notifications

phonestring | null

Contact phone number for alerts

readonlyboolean

When true, the user cannot change settings

administratorboolean

Grants full administrative privileges when enabled

mapstring | null

Preferred default map layer for the user

latitudenumber

Default map center latitude for this user

longitudenumber

Default map center longitude for this user

zoominteger

Default map zoom level on login

passwordstring

Password for user authentication

coordinateFormatstring | null

Preferred coordinate display format

disabledboolean

Indicates whether the user account is disabled

expirationTimestring<date-time> | null

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

deviceLimitinteger

Maximum number of devices the user can manage

userLimitinteger

Maximum number of subordinate users

deviceReadonlyboolean

Restricts user from modifying device attributes

limitCommandsboolean

Prevents user from sending unsupported commands

fixedEmailboolean

Locks the email field to avoid changes

poiLayerstring | null

External POI layer configured for the user

attributesobject

Additional custom user attributes

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Update a User

PUT

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

Update a User

curl -X PUT 'https://demo.traccar.org/api/users/0' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}'

const body = `{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}`;

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

const data = await response.text();

import requests

body = '''{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}'''

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

Request Body

{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

200

{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

Body

application/json

idinteger<int64>

Unique user identifier

namestring

User display name

emailstring

Email address used for login and notifications

phonestring | null

Contact phone number for alerts

readonlyboolean

When true, the user cannot change settings

administratorboolean

Grants full administrative privileges when enabled

mapstring | null

Preferred default map layer for the user

latitudenumber

Default map center latitude for this user

longitudenumber

Default map center longitude for this user

zoominteger

Default map zoom level on login

passwordstring

Password for user authentication

coordinateFormatstring | null

Preferred coordinate display format

disabledboolean

Indicates whether the user account is disabled

expirationTimestring<date-time> | null

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

deviceLimitinteger

Maximum number of devices the user can manage

userLimitinteger

Maximum number of subordinate users

deviceReadonlyboolean

Restricts user from modifying device attributes

limitCommandsboolean

Prevents user from sending unsupported commands

fixedEmailboolean

Locks the email field to avoid changes

poiLayerstring | null

External POI layer configured for the user

attributesobject

Additional custom user attributes

Parameters

idintegerrequiredpath

Response

200OKUser

Response fields application/json

idinteger<int64>

Unique user identifier

namestring

User display name

emailstring

Email address used for login and notifications

phonestring | null

Contact phone number for alerts

readonlyboolean

When true, the user cannot change settings

administratorboolean

Grants full administrative privileges when enabled

mapstring | null

Preferred default map layer for the user

latitudenumber

Default map center latitude for this user

longitudenumber

Default map center longitude for this user

zoominteger

Default map zoom level on login

passwordstring

Password for user authentication

coordinateFormatstring | null

Preferred coordinate display format

disabledboolean

Indicates whether the user account is disabled

expirationTimestring<date-time> | null

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

deviceLimitinteger

Maximum number of devices the user can manage

userLimitinteger

Maximum number of subordinate users

deviceReadonlyboolean

Restricts user from modifying device attributes

limitCommandsboolean

Prevents user from sending unsupported commands

fixedEmailboolean

Locks the email field to avoid changes

poiLayerstring | null

External POI layer configured for the user

attributesobject

Additional custom user attributes

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Delete a User

DELETE

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

Delete a User

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

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

const data = await response.text();

import requests

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