> 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.md).

# Platform API

- [Navixy platform API](https://navixy.com/docs/navixy-api/user-api/getting-started.md): What the Platform API covers, its core concepts, and how to use this documentation.
- [Platform authentication](https://navixy.com/docs/navixy-api/user-api/authentication.md): How to authenticate to the Platform API, and how to send the credential with a request.
- [Guides and examples](https://navixy.com/docs/navixy-api/user-api/guides.md): Whole tasks worked end to end, with the calls in the order an integration makes them.
- [Data retrieval](https://navixy.com/docs/navixy-api/user-api/guides/data-retrieval.md): Worked examples of getting trackers, tracks, sensor readings, and reports out of the Navixy platform.
- [Getting track points](https://navixy.com/docs/navixy-api/user-api/guides/data-retrieval/get-track-points.md)
- [Getting list of GPS trackers](https://navixy.com/docs/navixy-api/user-api/guides/data-retrieval/get-tracker-list.md)
- [Obtaining report information](https://navixy.com/docs/navixy-api/user-api/guides/data-retrieval/obtain-reports.md)
- [Retrieving sensor and counter data](https://navixy.com/docs/navixy-api/user-api/guides/data-retrieval/sensor-data.md)
- [Device management](https://navixy.com/docs/navixy-api/user-api/guides/device-management.md): Registering devices, configuring them remotely, and tracking things that carry no device of their own.
- [Activate device](https://navixy.com/docs/navixy-api/user-api/guides/device-management/activate-device.md)
- [Sending commands to a GPS tracker via IP protocol (OTA)](https://navixy.com/docs/navixy-api/user-api/guides/device-management/send-commands.md)
- [Tracking stationary objects with BLE tags](https://navixy.com/docs/navixy-api/user-api/guides/device-management/ble-beacons.md)
- [Field service management](https://navixy.com/docs/navixy-api/user-api/guides/field-service-management.md): Worked examples of assigning work to field employees and collecting what they report back.
- [Changing employee statuses](https://navixy.com/docs/navixy-api/user-api/guides/field-service-management/change-task-statuses.md)
- [Working with check-ins](https://navixy.com/docs/navixy-api/user-api/guides/field-service-management/check-ins.md)
- [Using task forms](https://navixy.com/docs/navixy-api/user-api/guides/field-service-management/create-forms.md)
- [How to create and assign tasks](https://navixy.com/docs/navixy-api/user-api/guides/field-service-management/manage-tasks.md)
- [Fleet management](https://navixy.com/docs/navixy-api/user-api/guides/fleet-management.md): Worked examples of vehicle records, maintenance, driver journals, and tags.
- [Using driver journals](https://navixy.com/docs/navixy-api/user-api/guides/fleet-management/driver-journals.md)
- [Managing vehicles and service works](https://navixy.com/docs/navixy-api/user-api/guides/fleet-management/service-works.md)
- [Using tags](https://navixy.com/docs/navixy-api/user-api/guides/fleet-management/use-tags.md)
- [Places](https://navixy.com/docs/navixy-api/user-api/guides/places.md): Worked examples of geofences and points of interest, the two ways a location gets a name.
- [Managing geofences](https://navixy.com/docs/navixy-api/user-api/guides/places/manage-geofences.md)
- [Managing POIs](https://navixy.com/docs/navixy-api/user-api/guides/places/manage-pois.md)
- [Rules and notifications](https://navixy.com/docs/navixy-api/user-api/guides/rules-notifications.md): Worked examples of setting conditions, reading the events they log, and delivering them to an app.
- [Receiving push notifications in your app](https://navixy.com/docs/navixy-api/user-api/guides/rules-notifications/get-push-notifications.md)
- [Using rules](https://navixy.com/docs/navixy-api/user-api/guides/rules-notifications/use-rules.md)
- [Working with notifications](https://navixy.com/docs/navixy-api/user-api/guides/rules-notifications/work-with-notifications.md)
- [Requesting Raw IoT Data](https://navixy.com/docs/navixy-api/user-api/guides/raw-data.md): How to request raw tracker data from Navixy Raw IoT Data API and typical use cases.
- [Resources](https://navixy.com/docs/navixy-api/user-api/resources.md): The operation reference for the Platform API, grouped by resource family.
- [Tracking](https://navixy.com/docs/navixy-api/user-api/resources/tracking.md): Devices, where they have been, and the map areas and rules that give their movement meaning.
- [APN settings](https://navixy.com/docs/navixy-api/user-api/resources/tracking/apn_settings.md): Mobile-internet settings a SIM needs before a device on it can reach the Navixy platform, looked up by phone number.
- [Delivery info](https://navixy.com/docs/navixy-api/user-api/resources/tracking/delivery.md): Delivery states for courier apps, carrying the task being delivered, the tracker carrying it, and the driver.
- [Geocoder](https://navixy.com/docs/navixy-api/user-api/resources/tracking/geocoder.md): Turn an address into map locations, and a location back into an address.
- [Map layer](https://navixy.com/docs/navixy-api/user-api/resources/tracking/map_layer.md): User-supplied KML overlays drawn on top of the Navixy platform's map.
- [Retranslator](https://navixy.com/docs/navixy-api/user-api/resources/tracking/retranslator.md): Forward the data a device sends to the Navixy platform on to a third-party server.
- [BLE beacon data](https://navixy.com/docs/navixy-api/user-api/resources/tracking/beacon.md): What a tracker saw of the radio tags around it, as history or as last known values.
- [Route](https://navixy.com/docs/navixy-api/user-api/resources/tracking/route.md): Driving routes between points, built by an external routing provider.
- [Route with Google](https://navixy.com/docs/navixy-api/user-api/resources/tracking/route/route_google.md): Build a driving route with the Google Directions API, and read back Google's own failure codes.
- [Route with OSRM](https://navixy.com/docs/navixy-api/user-api/resources/tracking/route/route_osrm.md): Build a driving route with OSRM, and read back OSRM's own failure detail.
- [Route with Progorod](https://navixy.com/docs/navixy-api/user-api/resources/tracking/route/route_progorod.md): Build a driving route with the Progorod router, and read back which point it rejected.
- [Status](https://navixy.com/docs/navixy-api/user-api/resources/tracking/status.md): The individual activity states, such as busy or not busy, that a tracker can be set to.
- [Tracker's working status](https://navixy.com/docs/navixy-api/user-api/resources/tracking/status/tracker.md): Read and set the working status a particular tracker is currently in.
- [Listing](https://navixy.com/docs/navixy-api/user-api/resources/tracking/status/listing.md): The set of working statuses a tracker can be set to, assigned per tracker.
- [Tracker's working status list](https://navixy.com/docs/navixy-api/user-api/resources/tracking/status/listing/tracker.md): Assign a working status list to a tracker, or remove the assignment.
- [Track](https://navixy.com/docs/navixy-api/user-api/resources/tracking/track.md): A tracker's movement over a period, as trips with totals, as raw points, or as a KML file.
- [Waybill](https://navixy.com/docs/navixy-api/user-api/resources/tracking/track/waybill.md): Build a waybill document from a tracker's tracks over a period, returned as a DOCX file.
- [Waybill settings](https://navixy.com/docs/navixy-api/user-api/resources/tracking/track/waybill/settings.md): The waybill number stored by the last download, ready for the next document in the sequence.
- [Tracker](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker.md): The device registered in the Navixy platform, and the operations that register, read, configure, and command it.
- [Alarm mode](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/alarm_mode.md): Turn a tracker's alarm mode on or off, and read whether it is currently on.
- [APN settings by tracker](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/apn_settings.md): Look up the mobile-internet settings for a registered tracker, by its ID rather than its phone number.
- [Avatar](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/avatar.md): Upload the image shown for a tracker in the interface.
- [Chat](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/chat.md): Text messages exchanged between a supervisor and the person carrying a tracker.
- [Contact](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/contact.md): Deprecated. The account's trackers grouped by the contacts that share them.
- [Counters](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/counter.md): Odometer and engine-hour counters on a tracker, and the values they hold.
- [Datalogger](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/datalogger.md): Upload track data a device recorded offline, so it joins the tracker's history.
- [Employee](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/employee.md): Assign an employee as the driver of a tracker, and read who is assigned now.
- [Engine immobilizer](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/engine_immobilizer.md): Read whether a vehicle's engine immobilizer is engaged, and engage or release it.
- [Group](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/group.md): A visual grouping of trackers in the interface, with a title and a colour.
- [LED](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/led.md): Read and switch a tracker's indicator LED, on models that expose it.
- [Mobile app register](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/mobile.md): Deprecated. Register a mobile application as a tracker.
- [Digital output](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/output.md): Switch a device's built-in digital outputs, one at a time or all at once.
- [Sensor readings](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/readings.md): The last value of every sensor, state field and counter on a tracker, in one call.
- [Retranslator binding](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/retranslator.md): Which retranslators forward a given tracker's data, and how to change that.
- [Trusted number](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/trusted_number.md): The phone numbers a device accepts SMS commands from.
- [Unconfirmed commands](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/command.md): The SMS commands still queued for a tracker, and a way to clear the queue.
- [Rules](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/rules.md): The conditions that make the Navixy platform log an event and notify someone, and the rule types available.
- [Rule](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/rules/rule.md): Conditions that make the Navixy platform log an event and notify someone when a tracker meets them.
- [Rule types](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/rules/rule_types.md): Every rule type a tracker can carry, with the parameters each one takes.
- [Sensor](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/sensor.md): The three kinds of sensor a tracker can carry, and the operations that manage them.
- [Sensor calibration data](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/sensor/calibration_data.md): The curve that converts a sensor's raw readings into meaningful units.
- [Sensor inputs](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/sensor/input_name.md): Every sensor input and state field the Navixy platform knows, with its description.
- [Settings](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/settings.md): A tracker's display label and the group it belongs to.
- [LBS settings](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/settings/lbs.md): The maximum radius accepted for a tracker's cell-tower and Wi-Fi positions.
- [Tracking mode](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/settings/tracking.md): How often and under what conditions a device transmits its data.
- [Tracking profiles](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/settings/tracking_profiles.md): What each device model accepts as its tracking mode settings, model by model.
- [Parking detection](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/settings/trip_detection.md): How the Navixy platform decides a tracker has stopped, which is what splits a trajectory into trips.
- [Special](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/settings/special.md): Model-specific settings that only some device models expose, each with its own object shape.
- [Manufacturer-specific settings](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/settings/special/portlets.md): Special settings objects that exist only for ATrack, Yatut, and Suntech device models.
- [Stats](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/stats.md): Engine hours and distance travelled, counted per day over a period.
- [Engine hours](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/stats/stats_engine_hours.md): How long a tracker's engine ran over a period, counted per day.
- [Mileage](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/stats/stats_mileage.md): How far a tracker travelled over a period, in kilometres, grouped by tracker and day.
- [Commands](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/commands.md): Reusable commands defined on a tracker, sent to the device or to a URL on demand.
- [Geofence](https://navixy.com/docs/navixy-api/user-api/resources/tracking/zone.md): Named map areas that limit where a rule applies and that name locations in reports.
- [Geofence import](https://navixy.com/docs/navixy-api/user-api/resources/tracking/zone/import.md): Create many circle geofences at once from a spreadsheet, through a background import process.
- [Geofence point](https://navixy.com/docs/navixy-api/user-api/resources/tracking/zone/zone_point.md): The points that give a polygon or sausage geofence its shape, read and replaced separately from the geofence.
- [Asset](https://navixy.com/docs/navixy-api/user-api/resources/tracking/asset.md): Tracks for an asset, resolved across every tracker the asset was attached to over the period.
- [Asset groups](https://navixy.com/docs/navixy-api/user-api/resources/tracking/asset/asset-groups.md): Group assets of different types so they are tracked and reported on together.
- [Geo links](https://navixy.com/docs/navixy-api/user-api/resources/location_link.md): Shareable sessions that show the live location of chosen trackers to someone without an account.
- [Billing](https://navixy.com/docs/navixy-api/user-api/resources/billing.md): The account's invoices, payments, and the service plans its devices are on.
- [Bill](https://navixy.com/docs/navixy-api/user-api/resources/billing/bill.md): An invoice raised against the account, and the payment link that settles it.
- [Payment system](https://navixy.com/docs/navixy-api/user-api/resources/billing/payment_system.md): The payment providers an account can pay through, and what a given payment would cost.
- [Subscription](https://navixy.com/docs/navixy-api/user-api/resources/billing/subscription.md): Recurring payments taken through 2Checkout, listed and cancelled.
- [Transaction](https://navixy.com/docs/navixy-api/user-api/resources/billing/transaction.md): The account's billing history over a period.
- [Tariff (plan)](https://navixy.com/docs/navixy-api/user-api/resources/billing/tariff.md): The service plans a device can be on, and what each one allows.
- [Tracker tariff](https://navixy.com/docs/navixy-api/user-api/resources/billing/tariff/tariff_tracker.md): Which tariff a device is on, and the rules governing a change to another.
- [User commons](https://navixy.com/docs/navixy-api/user-api/resources/commons.md): Account-level resources shared across the API, covering authentication, sub-users, history, tags, and platform metadata.
- [API keys](https://navixy.com/docs/navixy-api/user-api/resources/commons/api-keys.md): Long-lived credentials for integrations, used in place of a user session hash.
- [Base](https://navixy.com/docs/navixy-api/user-api/resources/commons/base.md): A health check that does nothing and reports success.
- [Data](https://navixy.com/docs/navixy-api/user-api/resources/commons/data.md): Turn a spreadsheet into the tab-separated file every import operation starts from.
- [Dealer](https://navixy.com/docs/navixy-api/user-api/resources/commons/dealer.md): The dealer's interface configuration and the platform-wide limits that constrain other operations.
- [Feedback](https://navixy.com/docs/navixy-api/user-api/resources/commons/feedback.md): Send a message from the user to platform support by email.
- [File](https://navixy.com/docs/navixy-api/user-api/resources/commons/file.md): How much of the account's file storage quota is in use.
- [Notification](https://navixy.com/docs/navixy-api/user-api/resources/commons/notification.md): Platform announcements shown to the current user.
- [Timezone](https://navixy.com/docs/navixy-api/user-api/resources/commons/timezone.md): Every timezone the Navixy platform supports, with localized descriptions.
- [Entity](https://navixy.com/docs/navixy-api/user-api/resources/commons/entity.md): Classes of object whose fields and layout an account can customize.
- [Entity fields](https://navixy.com/docs/navixy-api/user-api/resources/commons/entity/fields.md): Custom fields added to an entity, and the types they can take.
- [Entity search conditions](https://navixy.com/docs/navixy-api/user-api/resources/commons/entity/search_conditions.md): The filter expression that narrows an entity list by built-in and custom fields.
- [History](https://navixy.com/docs/navixy-api/user-api/resources/commons/history.md): The record of what trackers, assets, and users did, and the operations that read and mark it.
- [Tracker events](https://navixy.com/docs/navixy-api/user-api/resources/commons/history/history_tracker.md): The event history of one or more trackers over a period.
- [Event type](https://navixy.com/docs/navixy-api/user-api/resources/commons/history/history_type.md): Every event type the history can contain, with localized descriptions.
- [Unread events](https://navixy.com/docs/navixy-api/user-api/resources/commons/history/history_unread.md): The history entries a user has not read yet, listed or counted.
- [User events](https://navixy.com/docs/navixy-api/user-api/resources/commons/history/history-user.md): The account's own event history, as opposed to a tracker's.
- [Asset events](https://navixy.com/docs/navixy-api/user-api/resources/commons/history/asset-events.md): The event history of assets over a period, listed or counted.
- [Plugin](https://navixy.com/docs/navixy-api/user-api/resources/commons/plugin.md): Software modules that change how API calls behave, and which of them an account may use.
- [Report plugins](https://navixy.com/docs/navixy-api/user-api/resources/commons/plugin/report_plugins.md): Every report the Navixy platform can generate, with the plugin-specific parameters each one takes.
- [Report](https://navixy.com/docs/navixy-api/user-api/resources/commons/report.md): Generating tracker reports and delivering them on a schedule.
- [Report schedule](https://navixy.com/docs/navixy-api/user-api/resources/commons/report/report_schedule.md): Deliver a report to a user's mailbox on a repeating schedule.
- [Report tracker](https://navixy.com/docs/navixy-api/user-api/resources/commons/report/report_tracker.md): Generate, poll, retrieve, and download the account's tracker reports.
- [Sub-user](https://navixy.com/docs/navixy-api/user-api/resources/commons/subuser.md): Additional users with their own rights and their own subset of the account's trackers.
- [Sub-user places](https://navixy.com/docs/navixy-api/user-api/resources/commons/subuser/places.md): Which of the master account's places a sub-user can see.
- [Sub-user security group](https://navixy.com/docs/navixy-api/user-api/resources/commons/subuser/security_group.md): Named sets of rights assigned to sub-users, deciding what each of them may change.
- [Sub-user session](https://navixy.com/docs/navixy-api/user-api/resources/commons/subuser/session.md): Open a session as one of your sub-users, without knowing their password.
- [Sub-user trackers](https://navixy.com/docs/navixy-api/user-api/resources/commons/subuser/tracker.md): Which of the master account's trackers a sub-user can see.
- [Sub-user geofences](https://navixy.com/docs/navixy-api/user-api/resources/commons/subuser/zones.md): Which of the master account's geofences a sub-user can see.
- [Tag](https://navixy.com/docs/navixy-api/user-api/resources/commons/tag.md): Labels applied across entity types, used to group and find things that belong together.
- [Tag avatar](https://navixy.com/docs/navixy-api/user-api/resources/commons/tag/tag_avatar.md): The icon shown for a tag, uploaded as an image or assigned from the built-in set.
- [User](https://navixy.com/docs/navixy-api/user-api/resources/commons/user.md): Authenticating, reading who the session belongs to, and ending it.
- [User password](https://navixy.com/docs/navixy-api/user-api/resources/commons/user/password.md): Change a password with the current one, or set one from a restore link.
- [User personal info](https://navixy.com/docs/navixy-api/user-api/resources/commons/user/personal_info.md): The billing identity stored for an account, replaced wholesale on each update.
- [Audit](https://navixy.com/docs/navixy-api/user-api/resources/commons/user/audit.md): Record that a user opened or returned to the interface, for the audit log.
- [User audit log](https://navixy.com/docs/navixy-api/user-api/resources/commons/user/audit/audit_log.md): What the account's users did, so an owner can review activity across sub-users.
- [User authentication code](https://navixy.com/docs/navixy-api/user-api/resources/commons/user/auth.md): The second step of multi-factor authentication, verifying or resending the emailed code.
- [Session](https://navixy.com/docs/navixy-api/user-api/resources/commons/user/session.md): Extend the life of the current user session.
- [Delivery session](https://navixy.com/docs/navixy-api/user-api/resources/commons/user/session/delivery.md): A restricted session that lets an external system follow order and task tracking.
- [Push token](https://navixy.com/docs/navixy-api/user-api/resources/commons/user/session/push_token.md): Bind a device's push notification token to the current session, and filter what it receives.
- [Settings](https://navixy.com/docs/navixy-api/user-api/resources/commons/user/settings.md): An account's own preferences for timezone, formats, balance alerts, and file storage.
- [User UI settings](https://navixy.com/docs/navixy-api/user-api/resources/commons/user/settings/ui.md): A key-value store for client application state, kept per user but not guaranteed.
- [User applications](https://navixy.com/docs/navixy-api/user-api/resources/commons/user/applications.md): Third-party applications embedded into the Navixy platform interface, and how to manage them through the API.
- [App Connect](https://navixy.com/docs/navixy-api/user-api/resources/commons/user/applications/app-connect.md): Integrate custom applications with Navixy authentication
- [Field service](https://navixy.com/docs/navixy-api/user-api/resources/field-service.md): Employees in the field, the tasks assigned to them, and what they report back.
- [Check-ins](https://navixy.com/docs/navixy-api/user-api/resources/field-service/checkin.md): What a field employee reported from site, with a comment, a photo, and a filled form.
- [Departments](https://navixy.com/docs/navixy-api/user-api/resources/field-service/department.md): A group of employees, used to organise them into teams.
- [Employee](https://navixy.com/docs/navixy-api/user-api/resources/field-service/employee.md): The people working for an account, linked to the trackers, vehicles, and places they work with.
- [Employee avatar](https://navixy.com/docs/navixy-api/user-api/resources/field-service/employee/avatar.md): The icon shown for an employee, assigned from the built-in set or uploaded.
- [Employee import](https://navixy.com/docs/navixy-api/user-api/resources/field-service/employee/import.md): Create many employees at once from a spreadsheet, through a background import process.
- [Form](https://navixy.com/docs/navixy-api/user-api/resources/field-service/form.md): Structured information collected from a field employee when they complete a task or check in.
- [Form fields and values](https://navixy.com/docs/navixy-api/user-api/resources/field-service/form/field-types.md): The field types a form can hold, with the parameters each takes and the shape of the value it produces.
- [Form templates](https://navixy.com/docs/navixy-api/user-api/resources/field-service/form/template.md): The reusable definition a single-use form is created from.
- [Place](https://navixy.com/docs/navixy-api/user-api/resources/field-service/place.md): Business locations that employees visit, called points of interest in the interface.
- [Place avatar](https://navixy.com/docs/navixy-api/user-api/resources/field-service/place/avatar.md): The icon shown for a place, assigned from the built-in set or uploaded.
- [Place import](https://navixy.com/docs/navixy-api/user-api/resources/field-service/place/import.md): Create many places at once from a spreadsheet, through a background import process.
- [Places (POI)](https://navixy.com/docs/navixy-api/user-api/resources/field-service/place/work-with-poi.md): Business locations that employees visit, called points of interest in the interface and places in the API.
- [Task](https://navixy.com/docs/navixy-api/user-api/resources/field-service/task.md): A job assigned to a tracked device, completed by visiting a place and meeting its conditions.
- [Checkpoints](https://navixy.com/docs/navixy-api/user-api/resources/field-service/task/checkpoint.md): The individual stops that make up a route, each essentially a task.
- [Task history](https://navixy.com/docs/navixy-api/user-api/resources/field-service/task/history.md): The record of how a task's fields and state changed over its life.
- [Form](https://navixy.com/docs/navixy-api/user-api/resources/field-service/task/form.md): Attach a form to a task, read it, and download it.
- [Task form files](https://navixy.com/docs/navixy-api/user-api/resources/field-service/task/form/file.md): Reserve and upload a file before submitting it as a form field value.
- [Task form values](https://navixy.com/docs/navixy-api/user-api/resources/field-service/task/form/values.md): Correct the values of a form that has already been submitted from the mobile app.
- [Route](https://navixy.com/docs/navixy-api/user-api/resources/field-service/task/route.md): A named, ordered set of checkpoints that must be visited in sequence.
- [Route optimization](https://navixy.com/docs/navixy-api/user-api/resources/field-service/task/route/optimize.md): Reorder a set of points so the total travel time between them is as small as possible.
- [Schedule](https://navixy.com/docs/navixy-api/user-api/resources/field-service/task/schedule.md): Schedule entries that create tasks automatically, each day they are due.
- [Task schedule checkpoints](https://navixy.com/docs/navixy-api/user-api/resources/field-service/task/schedule/checkpoint.md): Delete or convert a checkpoint on a scheduled route.
- [Schedule proposals](https://navixy.com/docs/navixy-api/user-api/resources/field-service/task/schedule/proposal.md): A preview of the tasks and routes a schedule will create over a date range.
- [Route schedules](https://navixy.com/docs/navixy-api/user-api/resources/field-service/task/schedule/route.md): Scheduled routes, created on a repeating basis like recurring tasks.
- [Fleet management](https://navixy.com/docs/navixy-api/user-api/resources/fleet.md): The vehicles behind the trackers, where they are maintained, and how their trips are categorised.
- [Garage (depot)](https://navixy.com/docs/navixy-api/user-api/resources/fleet/garage.md): The premises a fleet is maintained from, with its address and the people responsible.
- [Driver journal](https://navixy.com/docs/navixy-api/user-api/resources/fleet/driver_journal.md): Trips categorised as business or private, so transport use can be split between them.
- [Driver journal entry](https://navixy.com/docs/navixy-api/user-api/resources/fleet/driver_journal/entry.md): A trip that has been categorised, so transport use can be split between business and private.
- [Trip proposals](https://navixy.com/docs/navixy-api/user-api/resources/fleet/driver_journal/proposal.md): The raw trips over a period that a driver journal entry can be created from.
- [Vehicle](https://navixy.com/docs/navixy-api/user-api/resources/fleet/vehicle.md): The vehicle behind a tracker, carrying its VIN, consumption figures, and other details a device cannot report.
- [Vehicle avatar](https://navixy.com/docs/navixy-api/user-api/resources/fleet/vehicle/avatar.md): The icon shown for a vehicle, assigned from the built-in set or uploaded.
- [Vehicle import](https://navixy.com/docs/navixy-api/user-api/resources/fleet/vehicle/import.md): Create many vehicles at once from a spreadsheet, through a background import process.
- [Service task](https://navixy.com/docs/navixy-api/user-api/resources/fleet/vehicle/service-task.md): Scheduled maintenance on a vehicle, due by date, mileage, or engine hours.
- [Service task file](https://navixy.com/docs/navixy-api/user-api/resources/fleet/vehicle/service-task/file.md): Reserve and upload a file to attach to a service task.
- [Vehicle status listing](https://navixy.com/docs/navixy-api/user-api/resources/fleet/vehicle/listing.md): Deprecated. The list of statuses a vehicle could be set to.
- [Raw IoT Data API](https://navixy.com/docs/navixy-api/user-api/resources/data-warehouse-api.md): Overview of Navixy Raw IoT Data API.
- [Raw IoT Data](https://navixy.com/docs/navixy-api/user-api/resources/data-warehouse-api/raw-data.md): Contains API calls to retrieve trackers raw data.
- [Eco Fleet API](https://navixy.com/docs/navixy-api/user-api/resources/eco-fleet-api.md): Overview of Navixy Eco Fleet API
- [Fuel data resampling](https://navixy.com/docs/navixy-api/user-api/resources/eco-fleet-api/resampling.md)
- [Fuel sensor quality index](https://navixy.com/docs/navixy-api/user-api/resources/eco-fleet-api/sensors.md): Contains API calls to interact with fuel sensor quality index.
- [Login redirect](https://navixy.com/docs/navixy-api/user-api/resources/login-redirect.md): GET parameters that send a user straight to a chosen section of the login page, in a chosen language.
- [WebSocket](https://navixy.com/docs/navixy-api/user-api/websocket.md): Information about WebSocket API and how to open connection.
- [WebSocket events](https://navixy.com/docs/navixy-api/user-api/websocket/events.md): Information about WebSocket events with conditions for obtaining and message samples.
- [WebSocket subscription](https://navixy.com/docs/navixy-api/user-api/websocket/subscription.md): Information about WebSocket subscription and how to subscribe to every type of event.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.