Skip to content
Docs
Select language:English

/api/v1/vehicles

GET
/api/v1/vehicles
curl --request GET \
  --url 'https://example.com/api/v1/vehicles?limit=20&sort=name&dir=asc' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 20 >= 1 <= 200
cursor
string
<= 2048 characters
q
string
<= 200 characters
f.location
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.type
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.state
Any of:
string
/^[a-z_]{1,40}$/
f.reading
Any of:
string
Allowed values: fresh stale unknown none
f.due
Any of:
string
Allowed values: overdue soon
not
Any of:
string
Allowed values: location type state reading due
sort
string
Allowed values: name lastReading nextDue location
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
thing
required
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)$/
locationId
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)$/
shortCode
required
string | null
name
required
string | null
type
required
Any of:
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)$/
icon
required
string
name
required
string | null
builtinKey
required
string | null
quantity
required
number
lifecycle
required
string
derivedState
required
Array<string>
Allowed values: uncertain draft ended lent borrowed in_repair
path
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)$/
name
required
string
kind
required
string
Allowed values: place container
isUnplaced
required
boolean
shortCode
string | null
containerThumbUrl
required
string | null
thumbUrl
required
string | null
lastSeenAt
required
string | null
isContainer
required
boolean
meter
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)$/
unit
required
string
latest
object
value
required
string
takenAt
required
string
source
required
string
by
required
object
displayName
required
string
estimate
required
object
perDay
required
string | null
basisDays
required
number | null
ageDays
required
number | null
advice
required
string
Allowed values: none fresh stale unknown
nextDue
object
name
required
string
dueOn
string
dueValue
string
estimated
required
boolean
state
required
string
documentsDue
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)$/
kind
required
string
expiresOn
required
string
state
required
string
fuel
object
perHundred
required
string
unit
required
string
Allowed values: L kWh gal
distanceUnit
required
string
next_cursor
required
string | null
Example
{
  "items": [
    {
      "thing": {
        "derivedState": [
          "uncertain"
        ],
        "path": [
          {
            "kind": "place"
          }
        ]
      },
      "meter": {
        "estimate": {
          "advice": "none"
        }
      },
      "fuel": {
        "unit": "L"
      }
    }
  ]
}