Drivers

List Drivers

get/drivers

Request

Base URL
https://api.spoke.com/public/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/spoke/apis/spoke-api/docs/drivers/get.ts
A function with typed inputs. Its response is checked against the schema.

maxPageSizenumber

The maximum number of drivers to return.

pageTokenstring

The page token to continue from.

active'true' | 'false'

Filter by the active status of the driver. Inactive drivers will not be assigned to any routes.

The filter to apply to the list of drivers. The filter param is passed like this: ?filter[active]=true or like this: ?filter.active=true

Success

nextPageTokenstring nullable required

The next page token.

No recorded changes to this operation across all 1 revision of this API.