Ctrlk
Log inGet startedAsk Navixy AI
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Geo links

Shareable sessions that show the live location of chosen trackers to someone without an account.

A geo link is a shareable session that shows the live location of chosen trackers to someone who has no account on the Navixy platform. It is how a courier's position is shown to the customer expecting the delivery, or a vehicle's to a client waiting for it.

A link is active the moment it is created, so treat the hash the create call returns as live from that instant. status/change turns a link off without deleting it, and doing so also closes any session currently open against it.

Geo links replace the older Weblocator feature, which is why the right that governs them is still called weblocator_session_create and the tariff feature is still weblocator.

Geo link object

Lifetime object

Tracker object

Params object

Display options object

API actions

API base path: /tracker/location/link.

Operations that list no errors of their own return only the general error codes.

Required sub-user rights: weblocator_session_create.

Create geo link

post
/tracker/location/link/create

Create a geo link, a shareable session that shows the live location of chosen trackers to someone without an account. Returns the new link's ID.

A new link is active as soon as it is created: its enabled flag comes back true and the URL works immediately, so treat the returned hash as live from that moment. Deactivate it with tracker/location/link/status/change.

An account can hold up to 10,000 geo links.

The geo link object is flattened into the request body: its fields are sent at the top level rather than nested under an object. hash, create_date, creator_id, user_id and enabled are read-only. Sending them is accepted and ignored rather than refused, so it changes nothing. Do not send hash: it collides with the legacy hash authentication parameter and the request fails with error 3.

Requires the weblocator_session_create right, which additionally needs the weblocator tariff feature on at least one tracker.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
descriptionstring · max: 255Required

Description of the link. At most 255 printable characters; may be empty but must be present.

Responses
200

The created geo link

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
valueintegerOptional

ID of the new geo link.

post/tracker/location/link/create
POST /v2/tracker/location/link/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 486

{
  "description": "text",
  "trackers": [
    {
      "tracker_id": 1,
      "alias": null,
      "params": {
        "object_data": [
          "speed"
        ],
        "sensor_ids": [
          1
        ],
        "state_fields": [
          "text"
        ],
        "counters": [
          "text"
        ]
      }
    }
  ],
  "params": {
    "bounding_zone_ids": [
      1
    ],
    "bounding_mode": "inside",
    "place_ids": [
      1
    ],
    "place_custom_field_ids": [
      1
    ],
    "zone_ids": [
      1
    ],
    "display_options": {
      "map": "text",
      "autoscale": true,
      "show_icons": true,
      "show_driver_info": true,
      "show_vehicle_info": true,
      "trace_duration": 1
    }
  },
  "lifetime": {
    "from": "2026-08-24 09:00:00",
    "to": "2026-08-24 09:00:00"
  }
}
{
  "success": true,
  "value": 1
}

Errors

These errors come in addition to the general error codes:

  • 13 - Operation not permitted, when the user has insufficient rights.

  • 204 - Entity not found, when a geofence or place in the request is not found.

  • 217 - List contains nonexistent entities, when a tracker ID belongs to no tracker or to another user's.

  • 236 - Feature unavailable due to tariff restrictions, when a tracker in the request has no weblocator tariff feature.

  • 268 - Link cannot be created due to quota violation.

Required sub-user rights: weblocator_session_create.

Update geo link

post
/tracker/location/link/update

Replace a geo link's description, lifetime, trackers and parameters. id is required, and everything else is replaced by what is sent rather than merged.

The trackers, geofences, places and custom fields are re-checked only where the list actually changed, so an update that leaves them alone will not fail on an entity that has since become inaccessible.

The geo link object is flattened into the request body: its fields are sent at the top level rather than nested under an object. hash, create_date, creator_id, user_id and enabled are read-only. Sending them is accepted and ignored rather than refused, so it changes nothing. Do not send hash: it collides with the legacy hash authentication parameter and the request fails with error 3.

Requires the weblocator_session_create right, which additionally needs the weblocator tariff feature on at least one tracker.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
idinteger · min: 1Required

ID of the geo link to update.

descriptionstring · max: 255Required

Description of the link. At most 255 printable characters; may be empty but must be present.

Responses
200

Geo link updated

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/tracker/location/link/update
POST /v2/tracker/location/link/update HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 493

{
  "id": 1,
  "description": "text",
  "trackers": [
    {
      "tracker_id": 1,
      "alias": null,
      "params": {
        "object_data": [
          "speed"
        ],
        "sensor_ids": [
          1
        ],
        "state_fields": [
          "text"
        ],
        "counters": [
          "text"
        ]
      }
    }
  ],
  "params": {
    "bounding_zone_ids": [
      1
    ],
    "bounding_mode": "inside",
    "place_ids": [
      1
    ],
    "place_custom_field_ids": [
      1
    ],
    "zone_ids": [
      1
    ],
    "display_options": {
      "map": "text",
      "autoscale": true,
      "show_icons": true,
      "show_driver_info": true,
      "show_vehicle_info": true,
      "trace_duration": 1
    }
  },
  "lifetime": {
    "from": "2026-08-24 09:00:00",
    "to": "2026-08-24 09:00:00"
  }
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 13 - Operation not permitted, when the user has insufficient rights.

  • 201 - Not found in the database, when no link has the given ID or it belongs to another user.

  • 204 - Entity not found, when a geofence or place in the request is not found.

  • 217 - List contains nonexistent entities, when a tracker ID belongs to no tracker or to another user's.

  • 236 - Feature unavailable due to tariff restrictions, when a tracker in the request has no weblocator tariff feature.

Required sub-user rights: weblocator_session_create.

Activate or deactivate geo link

post
/tracker/location/link/status/change

Turn a geo link on or off without deleting it. Deactivating one also closes any sessions currently open against it.

is_active defaults to false, so a call that passes only id deactivates the link. Send it explicitly.

The change is recorded in the audit log. Setting the status it already has succeeds and does nothing.

Requires the weblocator_session_create right, which additionally needs the weblocator tariff feature on at least one tracker.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
idinteger · min: 1Required

ID of the geo link.

is_activebooleanRequired

Default false. true activates the link, false deactivates it.

Responses
200

Status changed

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/tracker/location/link/status/change
POST /v2/tracker/location/link/status/change HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "id": 1,
  "is_active": true
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 201 - Not found in the database, when no link has the given ID or it belongs to another user.

Read geo link

post
/tracker/location/link/read

Return one geo link by ID, including its hash, which is what identifies the link to the person it was shared with.

Also accepts GET with the same parameters as query-string values.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
idinteger · min: 1Required

ID of the geo link.

Responses
200

The geo link

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/tracker/location/link/read
POST /v2/tracker/location/link/read HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 8

{
  "id": 1
}
{
  "success": true,
  "value": {
    "id": 1,
    "hash": "text",
    "create_date": "text",
    "creator_id": 1,
    "enabled": true,
    "description": "text",
    "lifetime": {
      "from": "2026-08-24 09:00:00",
      "to": "2026-08-24 09:00:00"
    },
    "trackers": [
      {
        "tracker_id": 1,
        "alias": null,
        "params": {
          "object_data": [
            "speed"
          ],
          "sensor_ids": [
            1
          ],
          "state_fields": [
            "text"
          ],
          "counters": [
            "text"
          ]
        }
      }
    ],
    "params": {
      "bounding_zone_ids": [
        1
      ],
      "bounding_mode": "inside",
      "place_ids": [
        1
      ],
      "place_custom_field_ids": [
        1
      ],
      "zone_ids": [
        1
      ],
      "display_options": {
        "map": "text",
        "autoscale": true,
        "show_icons": true,
        "show_driver_info": true,
        "show_vehicle_info": true,
        "trace_duration": 1
      }
    }
  }
}

Errors

These errors come in addition to the general error codes:

  • 201 - Not found in the database, when no link has the given ID or it belongs to another user.

filter and conditions may be combined, in which case a link must match both. conditions takes the same search conditions used elsewhere in the API.

List geo links

post
/tracker/location/link/list

Return the account's geo links, with filtering, search conditions, sorting and pagination.

filter and conditions may be combined, in which case a link must match both.

Callable with an empty body. Also accepts GET.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
filterstring · max: 100Optional

Optional. Free-text filter applied across the searchable fields. At most 100 printable characters.

offsetintegerOptional

Optional. Default 0. Offset into the results, for pagination.

limitinteger · min: 1 · max: 10000Optional

Optional. Default and maximum 10000.

sortstring[] · max: 8Optional

Optional. Default ["id=asc"]. Each entry pairs a field with a direction, for example "create_date=desc". At most 8 entries, no duplicates. The fields available are id, create_date, expire_date, status, trackers, aliases, description, and creator (master user only). Directions are asc and desc; an entry without a direction is rejected. Sorting by status orders enabled, then not yet started, then expired, then disabled.

Responses
200

The geo links

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/tracker/location/link/list
POST /v2/tracker/location/link/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "filter": "text",
  "conditions": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "offset": 1,
  "limit": 1,
  "sort": [
    "text"
  ]
}
{
  "success": true,
  "list": [
    {
      "id": 1,
      "hash": "text",
      "create_date": "text",
      "creator_id": 1,
      "enabled": true,
      "description": "text",
      "lifetime": {
        "from": "2026-08-24 09:00:00",
        "to": "2026-08-24 09:00:00"
      },
      "trackers": [
        {
          "tracker_id": 1,
          "alias": null,
          "params": {
            "object_data": [
              "speed"
            ],
            "sensor_ids": [
              1
            ],
            "state_fields": [
              "text"
            ],
            "counters": [
              "text"
            ]
          }
        }
      ],
      "params": {
        "bounding_zone_ids": [
          1
        ],
        "bounding_mode": "inside",
        "place_ids": [
          1
        ],
        "place_custom_field_ids": [
          1
        ],
        "zone_ids": [
          1
        ],
        "display_options": {
          "map": "text",
          "autoscale": true,
          "show_icons": true,
          "show_driver_info": true,
          "show_vehicle_info": true,
          "trace_duration": 1
        }
      }
    }
  ]
}

Delete geo link

post
/tracker/location/link/delete

Delete a geo link. Anyone holding the link loses access immediately.

Unlike creating, updating and switching a link, deleting one needs no specific right.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
idinteger · min: 1Required

ID of the geo link.

Responses
200

Geo link deleted

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/tracker/location/link/delete
POST /v2/tracker/location/link/delete HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 8

{
  "id": 1
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 201 - Not found in the database, when no link has the given ID or it belongs to another user.

PreviousAsset groups
NextBilling

Last updated

Was this helpful?