Edit on GitHub Ask developers in the Community

Using MyGeotab URLs

This guide explains how to format a URL (Uniform Resource Locator) to obtain access to a specific page/feature in MyGeotab. This can be used to link to MyGeotab from an Internet application, sending an email notification, third-party applications and other customized functions.

To create a link to a page, the following URL structure is used:


The portions of the examples noted with < and > (e.g. <serverName>) indicate where the user will enter information specific to their requirements.

serverNameThe name of the server the database is on. For example, my.geotab.com
databaseNameThe name of the database. This is typically the company name used during registration. If there are spaces in the name, they are replaced with underscore characters (_)
pageThe MyGeotab web application page name
parametersAdditional arguments to apply to the request. For example, currentSortMode:deviceName will sort the devices on the device list page by name. Note: each additional parameter is separated by a comma


Browse to your database using this URL format


Note: If you are not yet logged in, you will be prompted for your credentials.

Standalone pages

Standalone pages are used to get a my.geotab.com page without the header and side menu. This is useful when specific functionality is required, for example adding a new vehicle to the system.

To create a link to a page, the following URL structure is used:


If you are not yet logged in, you will be prompted for your credentials.

Passing parameters to a page

Parameters are added at the end of the URL and each is separated by a comma. They work the same for both the normal and standalone page types. It is also important to note when no parameters are requested, the page will load with the default settings. The parameter and its value are always separated by a colon (“:”).


These links will navigate to the map pages showing the live position of a device with id b21, and with the group b1234 highlighted.



List of pages and accepted parameters

Page: devices

The list of devices in the system.

Default: list of all devices sorted by name.

sortModeSorts the list of devices in a specific waybyType — sort by devicebyName — sort by name
groupSelectionDivides the device list into subheadings, which are children groups of the selected parent<groupName> — parent group name that the device belongs to





Page: device

Edit an individual device.

Default: no default page, you must have an id parameter.

idGoes to a device’s edit page<deviceId>



Page: deviceSerialNo

Add a new device.

Default: add new device page. No parameters required.



Page: map

The map viewer page.

Default: shows the map with your default map settings.

liveVehicleIdsUsed to show the live location of a device by its id<list of deviceIds>
planRoutesShow a route on the map<list of deviceIds>
highlightGroupWill highlight all devices in that group on the map display<groupId>




Page: tripsHistory

The detailed vehicle trip history page.

Default: will request you to select settings from the drop down menus. You can define the settings using the parameters.

dateRangeSets the range of dates for the trips(interval:<value>) — values: Today, Yesterday, This Week, Last Week, This Month, Last Month, (interval:custom,startDate: <date1>,endDate:)`
entityTypeShow activity for drivers or devicesDevice — list device activity, Driver — list driver activity
selectedEntitiesVehicles to list information for!(<listOfEnitities>) or all




Page: zones

The zone list page.

Default: list of all zones by name.

sortOrderThe list order1 — list alphabetically, -1 — Invert the list
sortModeChoose how the sort the listzoneName — sorts by name, zoneType — sorts by type, zoneGroup — sorts by group





Page: zone

The zone edit page.

Default: No default available. Needs parameters.

idGoes to edit page for the selected zone<zoneId>



Page: notifications

The notification list page.

Default: full list of user notifications listed in order of most recent time.

sortOrderThe list order1 — list the most recent time first -1 — invert the list
sortModeSelects the sort modemachineName — sorts by machine
showDismissed:!tShows all dismissed messagesNone



Page: users

The user list page.

Default: list of all current users.

sortOrderThe list order1 — list alphabetically -1 — invert the list



Page: user

The user edit page.

Default: goes to add a new user page.

idThe user’s id. Will link to the edit page for that user<userId>



Page: options

The user preferences page.

Default: edit user preferences page, no parameters required.




It is possible to insert username and database credentials into a URL. Note that the user will be required to be logged in to utilize these types of links.

MyGeotab Page Example


Standalone Page Example


We do not support passing the password credential through the URL because it is unsafe.

Getting the session Id using the API

Refer to the Authentication section. Within that section the instructions explain the process of authenticating a user to obtain their session id.

Security Using the Session Id

By using the sessionId, a valid login is created for that account. Another user will be able to fully access that account as long as the sessionId credential remain valid. If an application is being created where the sessionId could potentially be viewed by another party, it is advised to generate the credentials using an account with access limited only to the necessary data.

Embedding MyGeotab inside an iFrame

Trusted domains only

Due to the risk of ClickJacking, MyGeotab will instruct the browser to prevent MyGeotab from loading inside a frame that came from an arbitrary domain. Customers wishing to utilize this feature must meet the minimum security requirements. Please contact your reseller for more details.

Info for resellers

If your customer wish to embed MyGeotab pages inside an iFrame, you need to request it through MyAdmin. Please, create a ticket specifying the URL of the MyGeotab database, business justification and URL on which it will be integrated. Geotab’s support team will initiate the process to get the requested domains approved.

This process can take some time as the domains need to be reviewed by Geotab’s security team before being added to the approved list by the development team.