Retrieve GPS points

Retrieve a list of GPS points for a device, vehicle, or group. The organization must have a Fleet Tracking subscription to receive data from this endpoint.

SecuritybearerAuth
Request
query Parameters
deviceIdentifier
string or null

Can use either device serial number or device ID.

Example: deviceIdentifier=5100FFFF-60B6-D7CD-3FA2-22CA712B0000
groupIdentifier
string or null

Can use group ID or root group ID.

Example: groupIdentifier=5100FFFF-60B6-D7CD-3FA2-22CA712B0000
vehicleIdentifier
string or null

Can use either VIN or vehicle ID.

Example: vehicleIdentifier=5100FFFF-60B6-D7CD-3FA2-22CA712B0000
includeSubGroups
boolean

If true, all descendant groups under the specified group are included.

Example: includeSubGroups=false
limit
integer or null

Number of records to return.

Example: limit=5000
offset
integer or null

Record to start with.

Example: offset=1500
startDate
string <date-time>

The start date must be within the last 60 days.

Example: startDate=2023-06-01
endDate
string <date-time>

End date to filter by.

Example: endDate=2023-06-02
dateOption
string

Takes either the word createdDate or the word timeInUtc and filters trackpoints by the field specified. Default value is timeInUtc.

Example: dateOption=timeInUtc
order
string or null

Sort direction.

Example: order=asc
Responses
200

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/gps
Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}