Skip to content
TLGPSDocumentation

Developer documentation

REST API / V1

Get Vehicle

REST API V1 resources, authentication and bounded reads.

Returns a single vehicle.

Endpoint

GET https://api.tlgps.athear.ly/v1/vehicles/{vehicle}
Authorization: Bearer <token>
Accept: application/json

Path Parameters

Parameter Type Description
vehicle UUID Vehicle UUID

Note

Resources are resolved by uuid rather than numeric identifiers.


Example:

GET https://api.tlgps.athear.ly/v1/vehicles/01900000-0000-7000-8000-000000000001
Authorization: Bearer <token>
Accept: application/json

Successful Response

{
    "data": {
        "uuid": "01900000-0000-7000-8000-000000000001",
        "plate_number": "NF-241",
        "brand": "Astra",
        "model": "M588FS",
        "company": {
            "uuid": "01900000-0000-7000-8000-000000000002",
            "name": "Northstar Fleet Operations"
        },
        "location": {
            "source": "realtime",
            "status": {
                "connection": "online",
                "movement": "moving"
            },
            "coordinates": {
                "latitude": 0.0,
                "longitude": 0.0
            },
            "geo_address": null,
            "speed": {
                "kmh": 62,
                "mps": 17.22
            },
            "gps_status": true,
            "angle": 175,
            "altitude": 12,
            "ignition": {
                "status": "on"
            },
            "oil": 81,
            "voltage": 13.7,
            "mileage": {
                "km": 2485047,
                "meters": 2485047000
            },
            "temperature": "28",
            "timestamps": {
                "gps": "2026-06-29T23:47:43+02:00",
                "received": "2026-06-29T23:47:43+02:00",
                "last_synced": null
            }
        }
    }
}

Possible Responses

Status Description
200 Vehicle returned successfully
401 Authentication required
403 Token lacks required ability
404 Vehicle not found or not visible to the authenticated user

Note

  • Vehicles are always filtered according to the authenticated user's visibility.
  • Tracking filters operate on the latest resolved vehicle state.
  • Vehicles without an assigned tracking device may return location: null.
  • Real-time state is automatically preferred over the last synchronized database state whenever available.

Public documentation · authorized integration access required

Engineering-maintained documentation. Examples use synthetic data and placeholder credentials.

Back to top