Skip to content
Bottle

List vehicles

GET
/vehicles
curl --request GET \
  --url 'https://example.com/vehicles?includeArchived=true' \
  --cookie bottle.session_token=<bottle.session_token>

A round belongs to a vehicle rather than to whoever is driving it: three vehicles might have six drivers between them. Says how many vehicles the plan carries and how many are on the road.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
includeArchived
string
default: false
Allowed values: true false

Responses

Section titled “Responses”

200

Section titled “200”

The fleet

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
>= 1 characters <= 80 characters
registration
required
string | null
<= 16 characters
startLocationId
required

UUID v7

string | null format: uuid
endLocationId
required

UUID v7

string | null format: uuid
areas
required
Array<string>
payloadKg
required
integer | null
volumeLitres
required
integer | null
notes
required
string | null
motDueOn
required
string | null format: date
servicedOn
required
string | null format: date
serviceDueOn
required
string | null format: date
archivedAt
required
string | null format: date-time
usualDriverUserId
required
string | null
usualDriverName
required
string | null
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
limit
required
integer | null
used
required
integer
Example
{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "name": "Van 1",
      "registration": "KT65 ABC",
      "startLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "endLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "payloadKg": 1200,
      "volumeLitres": 10000
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}