User commons

Account-level resources shared across the API, covering authentication, sub-users, history, tags, and platform metadata.

User commons holds what is not specific to a tracker or a task. The account itself and its credentials sit here, along with the sub-users who share it, the event history everything else writes into, and the tags and custom fields that cut across entity types.

Two entries matter before anything else works. User turns credentials into a session, and API keys replaces that session with a credential built for an integration. History is where the events that rules generate end up.

Operations in this section

API keys

Endpoint	Method	What it does
/api/key/create	POST	Create API key
/api/key/delete	POST	Delete API key
/api/key/list	POST	List API keys

Base

Endpoint	Method	What it does
/base/nothing	POST	Health check

Data

Endpoint	Method	What it does
/data/spreadsheet/parse	POST	Parse spreadsheet
/data/import/list	POST	List imports
/data/import/read	POST	Read import

Dealer

Endpoint	Method	What it does
/dealer/get_ui_config	POST	Get dealer UI config

Feedback

Endpoint	Method	What it does
/feedback/send_email	POST	Send feedback

File

Endpoint	Method	What it does
/file/stats/read	POST	Read file storage stats

Notification

Endpoint	Method	What it does
/notification/list	POST	List notifications

Timezone

Endpoint	Method	What it does
/timezone/list	POST	List timezones

Entity

Endpoint	Method	What it does
/entity/list	POST	List entities
/entity/read	POST	Read entity
/entity/update	POST	Update entity

Entity fields

Endpoint	Method	What it does
/entity/fields/read	POST	Read entity fields
/entity/fields/update	POST	Update entity fields

History

Endpoint	Method	What it does
/history/read	POST	Read history entry
/history/mark_read	POST	Mark history entry read
/history/mark_read_all	POST	Mark all history read

Tracker events

Endpoint	Method	What it does
/history/tracker/list	POST	List tracker history

Event type

Endpoint	Method	What it does
/history/type/list	POST	List history event types

Unread events

Endpoint	Method	What it does
/history/unread/list	POST	List unread history
/history/unread/count	POST	Count unread history

User events

Endpoint	Method	What it does
/history/user/list	POST	List user history

Asset events

Endpoint	Method	What it does
/history/asset/list	POST	List asset history
/history/asset/count	POST	Count asset history

Plugin

Endpoint	Method	What it does
/plugin/list	POST	List plugins

Report schedule

Endpoint	Method	What it does
/report/schedule/create	POST	Create report schedule
/report/schedule/update	POST	Update report schedule
/report/schedule/list	POST	List report schedules
/report/schedule/delete	POST	Delete report schedule

Report tracker

Endpoint	Method	What it does
/report/tracker/generate	POST	Generate report
/report/tracker/status	POST	Get report status
/report/tracker/retrieve	POST	Retrieve report
/report/tracker/download	POST	Download report
/report/tracker/list	POST	List reports
/report/tracker/delete	POST	Delete report

Sub-user

Endpoint	Method	What it does
/subuser/list	POST	List sub-users
/subuser/register	POST	Register sub-user
/subuser/update	POST	Update sub-user
/subuser/delete	POST	Delete sub-user

Sub-user places

Endpoint	Method	What it does
/subuser/places/bind	POST	Bind places to sub-user
/subuser/places/unbind	POST	Unbind places from sub-user
/subuser/places/list_ids	POST	List sub-user place IDs
/subuser/places/list	POST	List sub-user places

Sub-user security group

Endpoint	Method	What it does
/subuser/security_group/create	POST	Create security group
/subuser/security_group/delete	POST	Delete security group
/subuser/security_group/list	POST	List security groups
/subuser/security_group/update	POST	Update security group
/subuser/security_group/assign	POST	Assign security group

Sub-user session

Endpoint	Method	What it does
/subuser/session/create	POST	Create sub-user session

Sub-user trackers

Endpoint	Method	What it does
/subuser/tracker/bind	POST	Bind trackers to sub-user
/subuser/tracker/unbind	POST	Unbind trackers from sub-user
/subuser/tracker/list	POST	List sub-user trackers

Sub-user geofences

Endpoint	Method	What it does
/subuser/zones/bind	POST	Bind geofences to sub-user
/subuser/zones/unbind	POST	Unbind geofences from sub-user
/subuser/zones/list_ids	POST	List sub-user geofence IDs
/subuser/zones/list	POST	List sub-user geofences

Tag

Endpoint	Method	What it does
/tag/create	POST	Create tag
/tag/delete	POST	Delete tags
/tag/list	POST	List tags
/tag/search	POST	Search entities by tag
/tag/update	POST	Update tag

Tag avatar

Endpoint	Method	What it does
/tag/avatar/assign	POST	Assign tag icon
/tag/avatar/upload	POST	Upload tag avatar

User

Endpoint	Method	What it does
/user/auth	POST	Authenticate user
/user/activate	POST	Activate user
/user/resend_activation	POST	Resend activation email
/user/get_info	POST	Get user info
/user/get_tariff_restrictions	POST	Get tariff restrictions
/user/logout	POST	Log out

User password

Endpoint	Method	What it does
/user/password/change	POST	Change password
/user/password/set	POST	Set password

User personal info

Endpoint	Method	What it does
/user/personal_info/update	POST	Update personal info

Audit

Endpoint	Method	What it does
/user/audit/checkin	POST	Record user check-in

User audit log

Endpoint	Method	What it does
/user/audit/log/list	POST	List audit log records

User authentication code

Endpoint	Method	What it does
/user/auth/code/verify	POST	Verify auth code
/user/auth/code/resend	POST	Resend auth code

Session

Endpoint	Method	What it does
/user/session/renew	POST	Renew session

Delivery session

Endpoint	Method	What it does
/user/session/delivery/create	POST	Create delivery session
/user/session/delivery/read	POST	Read delivery session

Push token

Endpoint	Method	What it does
/user/session/push_token/bind	POST	Bind push token
/user/session/push_token/delete	POST	Delete push token

Settings

Endpoint	Method	What it does
/user/settings/read	POST	Read user settings
/user/settings/update	POST	Update user settings
/user/settings/file_storage/update	POST	Update file storage settings

User UI settings

Endpoint	Method	What it does
/user/settings/ui/read	POST	Read UI setting
/user/settings/ui/update	POST	Update UI setting

User applications

Endpoint	Method	What it does
/user/application/list	POST	List user applications
/user/application/create	POST	Create user application
/user/application/update	POST	Update user application
/user/application/delete	POST	Delete user application
/user/application/enabled/set	POST	Show or hide a user application