Skip to content
Docs
Select language:English

/api/v1/things/{id}/fuel (GET)

GET
/api/v1/things/{id}/fuel
curl --request GET \
  --url 'https://example.com/api/v1/things/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fuel?limit=20&f.full=0&sort=takenAt&dir=asc'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 20 >= 1 <= 200
cursor
string
<= 2048 characters
f.when
string
<= 40 characters
f.unit
Any of:
string
Allowed values: L kWh gal
f.vendor
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
f.full
string
Allowed values: 0 1
not
Any of:
string
Allowed values: when unit vendor full
sort
string
Allowed values: takenAt amount cost
dir
string
Allowed values: asc desc

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
takenAt
required
string
amount
required
string
unit
required
string
Allowed values: L kWh gal
isFull
required
boolean
missedBefore
required
boolean
cost
string
currency
string
moneyHidden
boolean
pricePerUnit
string
vendor
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
reading
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
value
required
string
state
required
string
Allowed values: accepted needs_review
receipt
object
attachmentId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
fileId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
thumbUrl
required
string | null
loggedBy
required
object
displayName
required
string
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
next_cursor
required
string | null
Example
{
  "items": [
    {
      "unit": "L",
      "moneyHidden": true,
      "reading": {
        "state": "accepted"
      }
    }
  ]
}