List Meter Entries

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

List your Meter Entries

Request

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.
category object
includestringrequired
meterable_type object
includestringrequired
meterable_id object
eqstringrequired
vehicle_id object
eqstringrequired
date object
oneOf
EqFilter
eqstringrequired
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
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

dateSortAscDesc (string)

Possible values: [asc, 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
category object
includestringrequired
MOD2
meterable_type object
includestringrequired
MOD3
meterable_id object
eqstringrequired
MOD4
vehicle_id object
eqstringrequired
MOD5
date object
oneOf
EqFilter
eqstringrequired
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD6
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD7
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
dateSortAscDesc (string)
Possible values: [asc, desc]
MOD2
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD4
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idintegerrequired
auto_voided_atdate-timenullablerequired
The date and time at which this Meter Entry was automatically voided.
Example: 2023-03-14T13:46:27-06:00
categorystringnullablerequired
A category to describe the function of this Meter Entry.
Possible values: [starting, ending, nightly, manual]
meter_typestringrequired
Indicates whether this meter is a primary or secondary meter.
Possible values: [primary, secondary]
meterable_idintegernullablerequired
The id of the object with which this Meter Entry is associated.
meterable_typestringnullablerequired
The type of the object with which this Meter Entry is associated.
Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]
valuestringrequired
The current value of the meter.
vehicle_idintegernullablerequired
The id of the Vehicle associated with this meter entry, if any.
voidbooleanrequired
Indicates whether or not this Meter Entry has been voided.
Default value: false
typestringnullablerequired
Indicates if this Meter Entry was submitted by a GPS provider.
Possible values: [GpsMeterEntry]
gps_providerobjectnullablerequired
The GPS provider that submitted this Meter Entry.
datedaterequired
The date on which this Meter Entry was recorded.
Example: 2023-03-14
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "category": {
        "include": "string"
      }
    },
    {
      "meterable_type": {
        "include": "string"
      }
    },
    {
      "meterable_id": {
        "eq": "string"
      }
    },
    {
      "vehicle_id": {
        "eq": "string"
      }
    },
    {
      "date": {
        "eq": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "date": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "auto_voided_at": "2023-03-14T13:46:27-06:00",
      "category": "starting",
      "meter_type": "primary",
      "meterable_id": 0,
      "meterable_type": "FuelEntry",
      "value": "string",
      "vehicle_id": 0,
      "void": false,
      "type": "GpsMeterEntry",
      "gps_provider": {},
      "date": "2023-03-14"
    }
  ]
}

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

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/meter_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

Parameters

start_cursor — query

per_page — query

filter — query

categoryinclude

meterable_typeinclude

meterable_ideq

vehicle_ideq

dateeqltltegtgte

created_atltltegtgte

updated_atltltegtgte

sort — query

id---ascdesc

date---ascdesc

created_at---ascdesc

updated_at---ascdesc

ResponseClear

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