List Location Entries

GET 
https://secure.fleetio.com/api/v1/vehicles/:id/location_entries

Returns a list of your Location Entries.

Request

Path Parameters

id stringrequired

Query Parameters

start_cursor string

The start cursor for Keyset pagination.

per_page integer
Possible values: >= 2 and <= 100
The number of records per page to return.
Default value: 50
filter object
The fields, operations, and values to filter the records by.
contact_id object
eqstringrequired
locatable_id object
eqstringrequired
locatable_type object
eqstringrequired
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
sort object

The fields and direction to sort the results by.

idSortAscDescDefaultDesc (string)

Possible values: [asc, desc]

Default value: desc

created_atSortAscDesc (string)

Possible values: [asc, desc]

updated_atSortAscDesc (string)

Possible values: [asc, desc]

Responses

200

OK

application/json

Schema

Schema

start_cursorstringnullable
The current start cursor of the records returned.
next_cursorstringnullable
The next cursor to retrieve the next page of records.
per_pageinteger
The maxumum number of records returned.
estimated_remaining_countinteger
The number of remaining records including the returned records, up to a maximum of 500.
filtered_by object[]
The filters applied to the returned record set.
Array [
anyOf
MOD1
contact_id object
eqstringrequired
MOD2
locatable_id object
eqstringrequired
MOD3
locatable_type object
eqstringrequired
MOD4
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD5
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
]
sorted_by object[]
The sorts applied to the returned record set.
Array [
anyOf
MOD1
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD2
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idinteger
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
datedate-timerequired
The date and time at which this Location Entry was recorded.
Example: 2023-03-14T13:46:27-06:00
vehicle_idId (integer)
Possible values: >= 1
item_typestringrequired
The type of object that this Location Entry is associated with.
Possible values: [Vehicle, Equipment]
item_idNullableId (integer)nullablerequired
Possible values: >= 1
locatable_typestringnullablerequired
The type of object that triggered the creation of this Location Entry, if applicable.
Possible values: [FuelEntry, ServiceEntry, SubmittedInspectionForm]
locatable_idNullableId (integer)nullablerequired
Possible values: >= 1
contact_idNullableId (integer)nullablerequired
Possible values: >= 1
addressstringnullablerequired
The full address where this Location Entry took place.
address_components objectnullablerequired
street_numberstring
The street number in the address.
streetstring
The street name in the address.
citystring
The city in the address.
regionstring
The region, state or province in the address.
region_shortstring
The abbreviated region, state or province code.
countrystring
The country in the address.
country_shortstring
The abbreviated country code.
postal_codestring
The postal code, ZIP, or equivalent in the address.
is_currentbooleanrequired
Indicates whether this Location Entry is the most recent one for this object.
locationstringrequired
A string representation of the recorded location.
Example: POINT (33.515000,-86.807610)
geolocation objectrequired
The coordinates of the recorded location.
latitudeCoordinate (number)
Possible values: >= -90 and <= 90
longitudeCoordinate (number)
Possible values: >= -90 and <= 90
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "contact_id": {
        "eq": "string"
      }
    },
    {
      "locatable_id": {
        "eq": "string"
      }
    },
    {
      "locatable_type": {
        "eq": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "updated_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "date": "2023-03-14T13:46:27-06:00",
      "vehicle_id": 0,
      "item_type": "Vehicle",
      "item_id": 0,
      "locatable_type": "FuelEntry",
      "locatable_id": 0,
      "contact_id": 0,
      "address": "string",
      "address_components": {
        "street_number": "string",
        "street": "string",
        "city": "string",
        "region": "string",
        "region_short": "string",
        "country": "string",
        "country_short": "string",
        "postal_code": "string"
      },
      "is_current": true,
      "location": "POINT (33.515000,-86.807610)",
      "geolocation": {
        "latitude": 33.515,
        "longitude": -86.80761
      }
    }
  ]
}

400

The format or parameters of the request was invalid

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

404

The requested resource could not be located

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/vehicles/:id/location_entries' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

start_cursor — query

per_page — query

filter — query

contact_ideq

locatable_ideq

locatable_typeeq

created_atltltegtgte

updated_atltltegtgte

sort — query

id---ascdesc

created_at---ascdesc

updated_at---ascdesc

ResponseClear

Click the Send API Request button above and see the response here!