List Location Entries

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

Returns a list of your Location Entries.

Request

Responses

200

OK

Response Headers

X-PaginationLimit

The per page limit. Currently set to 100 but subject to change at any time.

X-Pagination-Current-Page

The current page. Defaults to 1.

X-Pagination-Total-Pages

The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

X-Pagination-Total-Count

The total number of records in the result set (across all pages).

application/json

Schema

Schema

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)

[
  {
    "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
    }
  }
]

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"
}

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/location_entries' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

ResponseClear

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