Skip to content
Bottle

List driver profiles

GET
/drivers
curl --request GET \
  --url https://example.com/drivers \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Every member with the driver role. Somebody who has not been given a vehicle yet is listed anyway.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Drivers

Media typeapplication/json
object
items
required
Array<object>
object
routingPreferences
string
<= 2000 characters
userId
required
string
accountName
required
string
role

Owner: billing, deleting the tenant, full control of members. admin: all operational work and may manage drivers and admins. driver: their own round only.

string
Allowed values: owner admin driver technical
name
required
string
preferredName
required
string | null
email
string format: email
usualVehicleId
required

UUID v7

string | null format: uuid
usualVehicleName
required
string | null
startLocationId
required

UUID v7

string | null format: uuid
endLocationId
required

UUID v7

string | null format: uuid
yardId
required

UUID v7

string | null format: uuid
yardName
required
string | null
shiftStart
required
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
shiftEnd
required
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
breakMinutes
required
integer | null
deliveryWindowHours
required
Any of:
number
Allowed values: 1
anyDeliveryArea
required
boolean
patchIds
required
Array<string>
licenceNumber
required
string | null
licenceExpiresOn
required
string | null format: date
homeAddressLine1
string | null
homeAddressLine2
string | null
homeAddressCity
string | null
homeAddressPostcode
string | null
updatedAt
required
string format: date-time

Example 

{
  "items": [
    {
      "role": "owner",
      "usualVehicleId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "startLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "endLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "yardId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "shiftStart": "07:30",
      "shiftEnd": "07:30",
      "deliveryWindowHours": 1,
      "patchIds": [
        "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
      ]
    }
  ]
}

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