> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/commons.md). # 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](/docs/navixy-api/user-api/resources/commons/user.md) turns credentials into a session, and [API keys](/docs/navixy-api/user-api/resources/commons/api-keys.md) replaces that session with a credential built for an integration. [History](/docs/navixy-api/user-api/resources/commons/history.md) is where the events that rules generate end up. ## Operations in this section #### API keys | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------ | ------ | -------------- | | [`/api/key/create`](/docs/navixy-api/user-api/resources/commons/api-keys.md#post-api-key-create) | POST | Create API key | | [`/api/key/delete`](/docs/navixy-api/user-api/resources/commons/api-keys.md#post-api-key-delete) | POST | Delete API key | | [`/api/key/list`](/docs/navixy-api/user-api/resources/commons/api-keys.md#post-api-key-list) | POST | List API keys | #### Base | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------- | ------ | ------------ | | [`/base/nothing`](/docs/navixy-api/user-api/resources/commons/base.md#post-base-nothing) | POST | Health check | #### Data | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------ | ------ | ----------------- | | [`/data/spreadsheet/parse`](/docs/navixy-api/user-api/resources/commons/data.md#post-data-spreadsheet-parse) | POST | Parse spreadsheet | | [`/data/import/list`](/docs/navixy-api/user-api/resources/commons/data.md#post-data-import-list) | POST | List imports | | [`/data/import/read`](/docs/navixy-api/user-api/resources/commons/data.md#post-data-import-read) | POST | Read import | #### Dealer | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------------------------- | ------ | -------------------- | | [`/dealer/get_ui_config`](/docs/navixy-api/user-api/resources/commons/dealer.md#post-dealer-get_ui_config) | POST | Get dealer UI config | #### Feedback | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------------------------- | ------ | ------------- | | [`/feedback/send_email`](/docs/navixy-api/user-api/resources/commons/feedback.md#post-feedback-send_email) | POST | Send feedback | #### File | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------------- | ------ | ----------------------- | | [`/file/stats/read`](/docs/navixy-api/user-api/resources/commons/file.md#post-file-stats-read) | POST | Read file storage stats | #### Notification | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------------------------- | ------ | ------------------ | | [`/notification/list`](/docs/navixy-api/user-api/resources/commons/notification.md#post-notification-list) | POST | List notifications | #### Timezone | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------------- | ------ | -------------- | | [`/timezone/list`](/docs/navixy-api/user-api/resources/commons/timezone.md#post-timezone-list) | POST | List timezones | #### Entity | Endpoint | Method | What it does | | -------------------------------------------------------------------------------------------- | ------ | ------------- | | [`/entity/list`](/docs/navixy-api/user-api/resources/commons/entity.md#post-entity-list) | POST | List entities | | [`/entity/read`](/docs/navixy-api/user-api/resources/commons/entity.md#post-entity-read) | POST | Read entity | | [`/entity/update`](/docs/navixy-api/user-api/resources/commons/entity.md#post-entity-update) | POST | Update entity | #### Entity fields | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------------------------------------- | ------ | -------------------- | | [`/entity/fields/read`](/docs/navixy-api/user-api/resources/commons/entity/fields.md#post-entity-fields-read) | POST | Read entity fields | | [`/entity/fields/update`](/docs/navixy-api/user-api/resources/commons/entity/fields.md#post-entity-fields-update) | POST | Update entity fields | #### History | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------- | ------ | ----------------------- | | [`/history/read`](/docs/navixy-api/user-api/resources/commons/history.md#post-history-read) | POST | Read history entry | | [`/history/mark_read`](/docs/navixy-api/user-api/resources/commons/history.md#post-history-mark_read) | POST | Mark history entry read | | [`/history/mark_read_all`](/docs/navixy-api/user-api/resources/commons/history.md#post-history-mark_read_all) | POST | Mark all history read | #### Tracker events | Endpoint | Method | What it does | | --------------------------------------------------------------------------------------------------------------------------- | ------ | -------------------- | | [`/history/tracker/list`](/docs/navixy-api/user-api/resources/commons/history/history_tracker.md#post-history-tracker-list) | POST | List tracker history | #### Event type | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------------ | ------ | ------------------------ | | [`/history/type/list`](/docs/navixy-api/user-api/resources/commons/history/history_type.md#post-history-type-list) | POST | List history event types | #### Unread events | Endpoint | Method | What it does | | -------------------------------------------------------------------------------------------------------------------------- | ------ | -------------------- | | [`/history/unread/list`](/docs/navixy-api/user-api/resources/commons/history/history_unread.md#post-history-unread-list) | POST | List unread history | | [`/history/unread/count`](/docs/navixy-api/user-api/resources/commons/history/history_unread.md#post-history-unread-count) | POST | Count unread history | #### User events | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------------ | ------ | ----------------- | | [`/history/user/list`](/docs/navixy-api/user-api/resources/commons/history/history-user.md#post-history-user-list) | POST | List user history | #### Asset events | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------------------------------------- | ------ | ------------------- | | [`/history/asset/list`](/docs/navixy-api/user-api/resources/commons/history/asset-events.md#post-history-asset-list) | POST | List asset history | | [`/history/asset/count`](/docs/navixy-api/user-api/resources/commons/history/asset-events.md#post-history-asset-count) | POST | Count asset history | #### Plugin | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------- | ------ | ------------ | | [`/plugin/list`](/docs/navixy-api/user-api/resources/commons/plugin.md#post-plugin-list) | POST | List plugins | #### Report schedule | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------------------------ | ------ | ---------------------- | | [`/report/schedule/create`](/docs/navixy-api/user-api/resources/commons/report/report_schedule.md#post-report-schedule-create) | POST | Create report schedule | | [`/report/schedule/update`](/docs/navixy-api/user-api/resources/commons/report/report_schedule.md#post-report-schedule-update) | POST | Update report schedule | | [`/report/schedule/list`](/docs/navixy-api/user-api/resources/commons/report/report_schedule.md#post-report-schedule-list) | POST | List report schedules | | [`/report/schedule/delete`](/docs/navixy-api/user-api/resources/commons/report/report_schedule.md#post-report-schedule-delete) | POST | Delete report schedule | #### Report tracker | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------------------------- | ------ | ----------------- | | [`/report/tracker/generate`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-generate) | POST | Generate report | | [`/report/tracker/status`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-status) | POST | Get report status | | [`/report/tracker/retrieve`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-retrieve) | POST | Retrieve report | | [`/report/tracker/download`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-download) | POST | Download report | | [`/report/tracker/list`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-list) | POST | List reports | | [`/report/tracker/delete`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-delete) | POST | Delete report | #### Sub-user | Endpoint | Method | What it does | | --------------------------------------------------------------------------------------------------- | ------ | ----------------- | | [`/subuser/list`](/docs/navixy-api/user-api/resources/commons/subuser.md#post-subuser-list) | POST | List sub-users | | [`/subuser/register`](/docs/navixy-api/user-api/resources/commons/subuser.md#post-subuser-register) | POST | Register sub-user | | [`/subuser/update`](/docs/navixy-api/user-api/resources/commons/subuser.md#post-subuser-update) | POST | Update sub-user | | [`/subuser/delete`](/docs/navixy-api/user-api/resources/commons/subuser.md#post-subuser-delete) | POST | Delete sub-user | #### Sub-user places | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------------------ | ------ | --------------------------- | | [`/subuser/places/bind`](/docs/navixy-api/user-api/resources/commons/subuser/places.md#post-subuser-places-bind) | POST | Bind places to sub-user | | [`/subuser/places/unbind`](/docs/navixy-api/user-api/resources/commons/subuser/places.md#post-subuser-places-unbind) | POST | Unbind places from sub-user | | [`/subuser/places/list_ids`](/docs/navixy-api/user-api/resources/commons/subuser/places.md#post-subuser-places-list_ids) | POST | List sub-user place IDs | | [`/subuser/places/list`](/docs/navixy-api/user-api/resources/commons/subuser/places.md#post-subuser-places-list) | POST | List sub-user places | #### Sub-user security group | Endpoint | Method | What it does | | -------------------------------------------------------------------------------------------------------------------------------------------- | ------ | --------------------- | | [`/subuser/security_group/create`](/docs/navixy-api/user-api/resources/commons/subuser/security_group.md#post-subuser-security_group-create) | POST | Create security group | | [`/subuser/security_group/delete`](/docs/navixy-api/user-api/resources/commons/subuser/security_group.md#post-subuser-security_group-delete) | POST | Delete security group | | [`/subuser/security_group/list`](/docs/navixy-api/user-api/resources/commons/subuser/security_group.md#post-subuser-security_group-list) | POST | List security groups | | [`/subuser/security_group/update`](/docs/navixy-api/user-api/resources/commons/subuser/security_group.md#post-subuser-security_group-update) | POST | Update security group | | [`/subuser/security_group/assign`](/docs/navixy-api/user-api/resources/commons/subuser/security_group.md#post-subuser-security_group-assign) | POST | Assign security group | #### Sub-user session | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------------------------------------------- | ------ | ----------------------- | | [`/subuser/session/create`](/docs/navixy-api/user-api/resources/commons/subuser/session.md#post-subuser-session-create) | POST | Create sub-user session | #### Sub-user trackers | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------------------------------------------- | ------ | ----------------------------- | | [`/subuser/tracker/bind`](/docs/navixy-api/user-api/resources/commons/subuser/tracker.md#post-subuser-tracker-bind) | POST | Bind trackers to sub-user | | [`/subuser/tracker/unbind`](/docs/navixy-api/user-api/resources/commons/subuser/tracker.md#post-subuser-tracker-unbind) | POST | Unbind trackers from sub-user | | [`/subuser/tracker/list`](/docs/navixy-api/user-api/resources/commons/subuser/tracker.md#post-subuser-tracker-list) | POST | List sub-user trackers | #### Sub-user geofences | Endpoint | Method | What it does | | --------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------------ | | [`/subuser/zones/bind`](/docs/navixy-api/user-api/resources/commons/subuser/zones.md#post-subuser-zones-bind) | POST | Bind geofences to sub-user | | [`/subuser/zones/unbind`](/docs/navixy-api/user-api/resources/commons/subuser/zones.md#post-subuser-zones-unbind) | POST | Unbind geofences from sub-user | | [`/subuser/zones/list_ids`](/docs/navixy-api/user-api/resources/commons/subuser/zones.md#post-subuser-zones-list_ids) | POST | List sub-user geofence IDs | | [`/subuser/zones/list`](/docs/navixy-api/user-api/resources/commons/subuser/zones.md#post-subuser-zones-list) | POST | List sub-user geofences | #### Tag | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------- | ------ | ---------------------- | | [`/tag/create`](/docs/navixy-api/user-api/resources/commons/tag.md#post-tag-create) | POST | Create tag | | [`/tag/delete`](/docs/navixy-api/user-api/resources/commons/tag.md#post-tag-delete) | POST | Delete tags | | [`/tag/list`](/docs/navixy-api/user-api/resources/commons/tag.md#post-tag-list) | POST | List tags | | [`/tag/search`](/docs/navixy-api/user-api/resources/commons/tag.md#post-tag-search) | POST | Search entities by tag | | [`/tag/update`](/docs/navixy-api/user-api/resources/commons/tag.md#post-tag-update) | POST | Update tag | #### Tag avatar | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------ | ------ | ----------------- | | [`/tag/avatar/assign`](/docs/navixy-api/user-api/resources/commons/tag/tag_avatar.md#post-tag-avatar-assign) | POST | Assign tag icon | | [`/tag/avatar/upload`](/docs/navixy-api/user-api/resources/commons/tag/tag_avatar.md#post-tag-avatar-upload) | POST | Upload tag avatar | #### User | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------------------ | ------ | ----------------------- | | [`/user/auth`](/docs/navixy-api/user-api/resources/commons/user.md#post-user-auth) | POST | Authenticate user | | [`/user/activate`](/docs/navixy-api/user-api/resources/commons/user.md#post-user-activate) | POST | Activate user | | [`/user/resend_activation`](/docs/navixy-api/user-api/resources/commons/user.md#post-user-resend_activation) | POST | Resend activation email | | [`/user/get_info`](/docs/navixy-api/user-api/resources/commons/user.md#post-user-get_info) | POST | Get user info | | [`/user/get_tariff_restrictions`](/docs/navixy-api/user-api/resources/commons/user.md#post-user-get_tariff_restrictions) | POST | Get tariff restrictions | | [`/user/logout`](/docs/navixy-api/user-api/resources/commons/user.md#post-user-logout) | POST | Log out | #### User password | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------------------------------------- | ------ | --------------- | | [`/user/password/change`](/docs/navixy-api/user-api/resources/commons/user/password.md#post-user-password-change) | POST | Change password | | [`/user/password/set`](/docs/navixy-api/user-api/resources/commons/user/password.md#post-user-password-set) | POST | Set password | #### User personal info | Endpoint | Method | What it does | | -------------------------------------------------------------------------------------------------------------------------------- | ------ | -------------------- | | [`/user/personal_info/update`](/docs/navixy-api/user-api/resources/commons/user/personal_info.md#post-user-personal_info-update) | POST | Update personal info | #### Audit | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------------------------- | ------ | -------------------- | | [`/user/audit/checkin`](/docs/navixy-api/user-api/resources/commons/user/audit.md#post-user-audit-checkin) | POST | Record user check-in | #### User audit log | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------------------------------------- | ------ | ---------------------- | | [`/user/audit/log/list`](/docs/navixy-api/user-api/resources/commons/user/audit/audit_log.md#post-user-audit-log-list) | POST | List audit log records | #### User authentication code | Endpoint | Method | What it does | | --------------------------------------------------------------------------------------------------------------- | ------ | ---------------- | | [`/user/auth/code/verify`](/docs/navixy-api/user-api/resources/commons/user/auth.md#post-user-auth-code-verify) | POST | Verify auth code | | [`/user/auth/code/resend`](/docs/navixy-api/user-api/resources/commons/user/auth.md#post-user-auth-code-resend) | POST | Resend auth code | #### Session | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------ | ------ | ------------- | | [`/user/session/renew`](/docs/navixy-api/user-api/resources/commons/user/session.md#post-user-session-renew) | POST | Renew session | #### Delivery session | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------------------------------------------------------------- | ------ | ----------------------- | | [`/user/session/delivery/create`](/docs/navixy-api/user-api/resources/commons/user/session/delivery.md#post-user-session-delivery-create) | POST | Create delivery session | | [`/user/session/delivery/read`](/docs/navixy-api/user-api/resources/commons/user/session/delivery.md#post-user-session-delivery-read) | POST | Read delivery session | #### Push token | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ----------------- | | [`/user/session/push_token/bind`](/docs/navixy-api/user-api/resources/commons/user/session/push_token.md#post-user-session-push_token-bind) | POST | Bind push token | | [`/user/session/push_token/delete`](/docs/navixy-api/user-api/resources/commons/user/session/push_token.md#post-user-session-push_token-delete) | POST | Delete push token | #### Settings | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ---------------------------- | | [`/user/settings/read`](/docs/navixy-api/user-api/resources/commons/user/settings.md#post-user-settings-read) | POST | Read user settings | | [`/user/settings/update`](/docs/navixy-api/user-api/resources/commons/user/settings.md#post-user-settings-update) | POST | Update user settings | | [`/user/settings/file_storage/update`](/docs/navixy-api/user-api/resources/commons/user/settings.md#post-user-settings-file_storage-update) | POST | Update file storage settings | #### User UI settings | Endpoint | Method | What it does | | -------------------------------------------------------------------------------------------------------------------------- | ------ | ----------------- | | [`/user/settings/ui/read`](/docs/navixy-api/user-api/resources/commons/user/settings/ui.md#post-user-settings-ui-read) | POST | Read UI setting | | [`/user/settings/ui/update`](/docs/navixy-api/user-api/resources/commons/user/settings/ui.md#post-user-settings-ui-update) | POST | Update UI setting | #### User applications | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------------- | | [`/user/application/list`](/docs/navixy-api/user-api/resources/commons/user/applications.md#post-user-application-list) | POST | List user applications | | [`/user/application/create`](/docs/navixy-api/user-api/resources/commons/user/applications.md#post-user-application-create) | POST | Create user application | | [`/user/application/update`](/docs/navixy-api/user-api/resources/commons/user/applications.md#post-user-application-update) | POST | Update user application | | [`/user/application/delete`](/docs/navixy-api/user-api/resources/commons/user/applications.md#post-user-application-delete) | POST | Delete user application | | [`/user/application/enabled/set`](/docs/navixy-api/user-api/resources/commons/user/applications.md#post-user-application-enabled-set) | POST | Show or hide a user application | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://navixy.com/docs/navixy-api/user-api/resources/commons.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.