Skip to main content

Get drivers​

x-ms-visibility: "important"

Retrieve a list of all drivers associated with the user.

Query Parameters
    page int32

    Page to be fetched. Default: 1

    limit int32

    Limit (No. of records per page). Max value: 100. Default: 100.

    search string

    Free text filter for driver name.

    sortKey string

    Field to be used for sorting. Default: name

    sortDescending boolean

    Set to 'true' to sort descending based on sort key. Default: 'false'

    homeSiteId int32

    Filter by driver home site ID.

    tag string

    Filter by tag.

    externalId string

    Filter by external ID.

    referenceId string

    Filter by reference ID.

Responses

List of drivers accessible by the user.

Schema
    page int32
    limit int32
    totalRecords int32
    hasNextPage boolean
    hasPreviousPage boolean
    items object[]
  • Array [
    • id int64
    externalId string
    name string
    homeSiteId int64 nullable
    payerId int64 nullable
    homeSiteName string
    tags object[]
  • Array [
    • id int64
    idTag string
    expiringDate date-time
    startDate date-time nullable
    lastUpdated date-time nullable
    tokenName string
    invoicable boolean nullable
    driverId int64
  • ]
    • externalUserIds object[]
  • Array [
    • referenceType string
    referenceId string
    externalId string
    effectiveFrom date-time nullable
  • ]
  • ]
Loading...