List drivers

GET

api

{version}

drivers

List drivers

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/drivers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/drivers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/drivers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/drivers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

[
  {
    "Id": "<string>",
    "Name": "<string>",
    "Type": "<string>",
    "SubsidiaryId": "<string>",
    "Status": "<string>",
    "Notes": [
      {
        "id": "<string>",
        "Description": "<string>",
        "NoteType": "<string>",
        "User": "<string>",
        "Time": "2023-11-07T05:31:56Z",
        "UserId": "<string>"
      }
    ],
    "CreatedAt": "2023-11-07T05:31:56Z",
    "IsActive": true,
    "EmployeeId": "<string>",
    "PhoneNumber": "<string>",
    "UserId": "<string>",
    "Email": "<string>",
    "Address": {
      "Street": "<string>",
      "City": "<string>",
      "State": "<string>",
      "ZipCode": "<string>"
    },
    "LicenseNum": "<string>",
    "LicenseState": "<string>",
    "LicenseCountry": "<string>",
    "LicenseExpiresAt": "2023-11-07T05:31:56Z",
    "MedicalExpiresAt": "2023-11-07T05:31:56Z",
    "HiredAt": "2023-11-07T05:31:56Z",
    "TerminatedAt": "2023-11-07T05:31:56Z",
    "Fleet": {
      "Id": "<string>",
      "Name": "<string>",
      "InvoiceNumberPrefix": "<string>"
    },
    "References": [
      {
        "Name": "<string>",
        "Value": "<string>",
        "Id": "<string>",
        "ReferenceId": "<string>",
        "Type": "<string>",
        "Access": "<string>",
        "Origin": "<string>"
      }
    ]
  }
]

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

The GET Drivers API endpoint allows you to retrieve a comprehensive list of drivers within the Alvys system. This endpoint provides detailed information about each driver, facilitating effective driver management and tracking. The endpoint requires specifying the API version in the URL path. This ensures that your application interacts with the correct version of the API, providing stability and compatibility as the API evolves. For more information on how versioning works and how to include it in your requests, please refer to the Versioning page.

Request Parameters

The following parameter is required in the URL path:

Parameter	Type	Required	Description
version	String	Yes	The API version to use.

Example CURL request

curl --location 'https://integrations.alvys.com/api/p/v{version}/drivers' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace {version} with the API version number and YOUR_ACCESS_TOKEN with your actual Bearer token:

curl --location 'https://integrations.alvys.com/api/p/v1/drivers' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJjaWQiOiJBTDM2MyIsInZlc...'

Response Parameters

The following table lists the parameters included in the response for each driver in the list:

Parameter	Type	Description
Id	String	The unique identifier of the driver.
EmployeeId	String	The employee ID of the driver.
PhoneNumber	String	The phone number of the driver.
UserId	String	The user ID associated with the driver.
Email	String	The email address of the driver.
Name	String	The name of the driver.
Type	String	The type of driver (COMPANY, OWNER_OPERATOR, CONTRACTOR, EXTERNAL).
SubsidiaryId	String	The subsidiary ID to which the driver belongs.
Address	Object	The address details of the driver.
Address.Street	String	The street address of the driver.
Address.City	String	The city of the driver’s address.
Address.State	String	The state of the driver’s address.
Address.ZipCode	String	The zip code of the driver’s address.
Status	String	The current status of the driver (e.g., “SLEEPING”, “DRIVING”, “ON DUTY”, “OFF DUTY”, “ONLINE”, “OFFLINE”).
IsActive	Boolean	Indicates if the driver is currently active.
LicenseNum	String	The driver’s license number.
LicenseState	String	The state that issued the driver’s license.
LicenseCountry	String	The country where the driver’s license was issued (USA, Canada, Mexico).
LicenseExpiresAt	String (Date-Time)	The expiration date of the driver’s license.
MedicalExpiresAt	String (Date-Time)	The expiration date of the driver’s medical certificate.
HiredAt	String (Date-Time)	The date when the driver was hired.
TerminatedAt	String (Date-Time)	The date when the driver was terminated, if applicable.
Notes	Array	An optional list of notes related to the driver.
Notes.id	String	The unique identifier of the note.
Notes.Description	String	The description of the note.
Notes.NoteType	String	The type of the note.
Notes.Time	String (Date-Time)	The time the note was created.
Notes.User	String	The user who created the note.
Fleet	Object	The fleet information associated with the driver.
Fleet.Id	String	The unique identifier of the fleet.
Fleet.Name	String	The name of the fleet.
References	Array	An optional list of custom references associated with the driver.
CreatedAt	String (Date-Time)	The date and time when the driver was created in Alvys.

Example Response

On the right side, you can see examples of different error codes by clicking “Example” and selecting the response code.

Rate Limits

All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information on rate limits, please refer to the Rate Limits section. This page is interactive, allowing you to try a request by specifying the API version in the URL path. As you fill out the parameters, the Curl command on the right side of the page will be automatically updated. Alternatively, you can directly edit the Curl command. Make sure to authorize yourself before trying a request.

Authorizations

Authorization

string

header

required

OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.

Path Parameters

version

string

default:1.0

required

API version (e.g., 1.0)

Example:

"1.0"

Response

string

required

Name

string

required

Type

string

required

SubsidiaryId

string

required

Status

string

required

Notes

object[]

required

Show child attributes

CreatedAt

string<date-time>

required

IsActive

boolean

required

EmployeeId

string | null

PhoneNumber

string | null

UserId

string | null

Address

object | null

Show child attributes

LicenseNum

string | null

LicenseState

string | null

LicenseCountry

string | null

LicenseExpiresAt

string<date-time> | null

MedicalExpiresAt

string<date-time> | null

HiredAt

string<date-time> | null

TerminatedAt

string<date-time> | null

Fleet

object | null

Show child attributes

References

object[] | null

Show child attributes

⌘I

List drivers

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/drivers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/drivers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/drivers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/drivers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

[
  {
    "Id": "<string>",
    "Name": "<string>",
    "Type": "<string>",
    "SubsidiaryId": "<string>",
    "Status": "<string>",
    "Notes": [
      {
        "id": "<string>",
        "Description": "<string>",
        "NoteType": "<string>",
        "User": "<string>",
        "Time": "2023-11-07T05:31:56Z",
        "UserId": "<string>"
      }
    ],
    "CreatedAt": "2023-11-07T05:31:56Z",
    "IsActive": true,
    "EmployeeId": "<string>",
    "PhoneNumber": "<string>",
    "UserId": "<string>",
    "Email": "<string>",
    "Address": {
      "Street": "<string>",
      "City": "<string>",
      "State": "<string>",
      "ZipCode": "<string>"
    },
    "LicenseNum": "<string>",
    "LicenseState": "<string>",
    "LicenseCountry": "<string>",
    "LicenseExpiresAt": "2023-11-07T05:31:56Z",
    "MedicalExpiresAt": "2023-11-07T05:31:56Z",
    "HiredAt": "2023-11-07T05:31:56Z",
    "TerminatedAt": "2023-11-07T05:31:56Z",
    "Fleet": {
      "Id": "<string>",
      "Name": "<string>",
      "InvoiceNumberPrefix": "<string>"
    },
    "References": [
      {
        "Name": "<string>",
        "Value": "<string>",
        "Id": "<string>",
        "ReferenceId": "<string>",
        "Type": "<string>",
        "Access": "<string>",
        "Origin": "<string>"
      }
    ]
  }
]

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

​Request Parameters

​Example CURL request

​Response Parameters

​Example Response

​Rate Limits

Authorizations

Path Parameters

Response

Request Parameters

Example CURL request

Response Parameters

Example Response

Rate Limits