Skip to main content

GET - List of user gps logs

List of user gps logs

Request

  • Method: GET
  • Endpoint: /user-gps-logs
  • Base URL: https://api.targpatrol.com/api/v1
  • Operation ID: list-of-user-gps-logs

Authorization

This endpoint requires an external API key.

x-api-key: {your_external_api_key}

Parameters

NameInRequiredSchemaDescription
limitquerynointegerinclude first N items of a resource collection
offsetquerynonumberexclude first N items of a resource collection
sortquerynostringsort items in a resource collection
startAtquerynostringfilter logs by date greater than specified
endAtquerynostringfilter logs by date less than specified
userIdquerynostringfilter by user ids
locationIdquerynostringfilter by location ids

Responses

200 OK

Content-Type: application/json Schema: object

Schema
{
"allOf": [
{
"$ref": "#/components/schemas/PageResponse"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserGpsLogResponse"
}
}
}
}
]
}

Example: example-1

{
"data": [
{
"id": "be63c536-6cf3-4866-8970-37a956e3f403",
"userId": "1a3a6c47-b3ce-43de-bdd6-3c1e7757f23a",
"locationId": "fcf27e76-aed4-4067-adf6-508a77306ac4",
"date": "2026-06-20T01:00:00.000Z",
"latitude": 40.7,
"longitude": -73.9,
"accuracy": 5,
"altitude": 10,
"altitudeAccuracy": 1.5,
"heading": 45.5,
"speed": 8
}
],
"meta": {
"offset": 0,
"limit": 20,
"count": 1,
"sort": [
{
"property": "id",
"direction": "asc"
}
],
"filter": [
{
"property": "userId",
"value": "1a3a6c47-b3ce-43de-bdd6-3c1e7757f23a"
}
]
}
}

401 Unauthorized

500 Internal Server Error

Content-Type: application/json Schema: ErrorResponse

Schema
{
"$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
"message": "internal server error",
"code": "internal.server.error",
"timestamp": "2023-03-07T05:57:59.315Z"
}