PathStack

API Reference

Provider access guides

Legal

Sign up

Support

Geoforce

What is PathStack?

Common Use Cases

Explore the following guides and examples to integrate PathStack into your system.

Quickstart guide

Key concepts and definitions

Supported providers

This guide shows the steps for connecting your Telematics account to PathStack so you can access unified device data.

Connect telematics accounts

Authentication

Start requesting data

Realtime data collection

Pagination

Configuration and versioning

Verizon Connect

Digital Matter

Rand McNally (Fleetsu)

Geotab

MiX Telematics

Teletrac Navman

Netstar Australia

Radius Telematics

Volvo Dynafleet

Bridgestone Webfleet

Scania

Toyota Halo

Bestrane

Intellifleet

Linxio

Introduction

Data Provider Terms of Service

Data Consumer Terms of Service

Privacy Statement

Security Statement

Contact Information

This endpoint takes a username or email, and a password, and returns an access token, refresh token, expiry time,
token type, and a sub which is used with the refresh token to get a new access token by calling the refresh
endpoint.

The access token is to be used for all endpoints except for /token and /refresh.

Login

This endpoint takes the sub and a refresh token and returns an access token and refresh token.

The access token is to be used for all endpoints except for /token and /refresh.

Refresh

This endpoint returns all connections within your tenancy.

You can specify the telematics_provider, and it will return only Connections with that provider.

Connections

This endpoint takes attributes for a new Connection and a tenant_id and creates and returns a new Connection.

The allowed values for integration_name can be found under ProviderEnum.

Create Connection

This endpoint returns a Connection by ID.

Connection By Id

This endpoint returns all Devices that have been created by Connections for your Tenancy.

You can specify the telematics_provider, and it will return only Devices with that provider.

You can specify the tags, and it will return only Devices that have all the tags specified.

The response is paginated, so if the next link is not null, use that link to get the next page of results.

Devices

This endpoint creates a Device.

Not all providers are supported, currently only Digital Matter is supported.

The created Device is returned in the response.

Create Device

Device By Id

This endpoint deletes a Device.

Not all providers are supported, currently only Digital Matter is supported.

The deleted Device is returned in the response.

Delete Device By Id

This endpoint update a Device.

You can specify the attributes which you want to be updated and their new values.

The updated Device is returned in the response.

Update Device By Id

This endpoint returns the Trips for a Device.

You can optionally specify parameters for start_time_utc and end_time_utc to filter the results.

The response is paginated, so if the next link is not null, use that link to get the next page of results.

Trips

Trip By Id

This endpoint returns the Positions for a Device.

You can optionally specify parameters for start_time_utc and end_time_utc to filter the results.

You can enable OSM road classification by passing through include_osm_road_classification=true.

The response is paginated, so if the next link is not null, use that link to get the next page of results.

Positions

This endpoint returns the Positions for a Trip.

You can enable OSM road classification by passing through include_osm_road_classification=true.

The response is paginated, so if the next link is not null, use that link to get the next page of results.

Positions By Trip Id

This endpoint returns the most recent Position of each Device. You can optionally pass in filter_parameters to
filter the devices you will receive.

Get Realtime Positions

This endpoint returns an authenticated url for a websocket connection.

Get Connect

Get Webhooks

Create Webhook

Get Webhook

Delete Webhook

Modifies an existing webhook.

Note that setting "enabled" to true will reset `error_count` to 0, and clear
both `last_error` and `last_error_at` fields.

Patch Webhook

This endpoint returns all Tags on Devices for a Tenant.

Get Tags

This endpoint returns the Events for a Device.

You can optionally specify parameters for event_type, start_time_utc and end_time_utc to filter the results.

The response is paginated, so if the next link is not null, use that link to get the next page of results.

Events

Event By Id

Tenant By Id

This endpoint updates a Tenant.

You can specify the attributes which you want to be updated and their new values.

The updated Tenant is returned in the response.

Update Tenant By Id

Tenant Configuration

Get Milestone

Delete Milestone

Patch Milestone

Get Milestone Update

This endpoint returns all Share Requests that have been created.

Get Share Requests

This endpoint creates a Share Request.

The created Share Request is returned in the response.