Search drivers

POST

api

{version}

drivers

Search drivers

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/drivers/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "Page": 123,
  "PageSize": 123,
  "Status": [
    "<string>"
  ],
  "Name": "<string>",
  "EmployeeId": "<string>",
  "FleetName": "<string>",
  "IsActive": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Page: 123,
    PageSize: 123,
    Status: ['<string>'],
    Name: '<string>',
    EmployeeId: '<string>',
    FleetName: '<string>',
    IsActive: true
  })
};

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

import requests

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

payload = {
    "Page": 123,
    "PageSize": 123,
    "Status": ["<string>"],
    "Name": "<string>",
    "EmployeeId": "<string>",
    "FleetName": "<string>",
    "IsActive": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/drivers/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Page' => 123,
    'PageSize' => 123,
    'Status' => [
        '<string>'
    ],
    'Name' => '<string>',
    'EmployeeId' => '<string>',
    'FleetName' => '<string>',
    'IsActive' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"Status\": [\n    \"<string>\"\n  ],\n  \"Name\": \"<string>\",\n  \"EmployeeId\": \"<string>\",\n  \"FleetName\": \"<string>\",\n  \"IsActive\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integrations.alvys.com/api/p/v{version}/drivers/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"Status\": [\n    \"<string>\"\n  ],\n  \"Name\": \"<string>\",\n  \"EmployeeId\": \"<string>\",\n  \"FleetName\": \"<string>\",\n  \"IsActive\": true\n}")
  .asString();

{
  "Page": 123,
  "PageSize": 123,
  "Total": 123,
  "Items": [
    {
      "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>"
        }
      ]
    }
  ],
  "Facets": {}
}

{
  "Errors": {},
  "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>"
}

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

This endpoint provides detailed information about each driver that matches the search criteria, facilitating efficient management and retrieval of driver records. 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.

Body Request

The following fields can be included in the request body to filter the search results: <Table align={["left","left","left","left"]}> ParameterTypeRequiredDescription PageIntegerYesThe page number to retrieve.PageSizeIntegerYesThe number of results per page. PageSize must be greater than 0.StatusArray of StringsConditionallyA list of statuses to filter by. This field is required if the other conditionally required fields are left empty.NameStringConditionallyThe name of the driver to search for. This field is required if the other conditionally required fields are left empty.EmployeeIdStringConditionallyThe employee ID of the driver to search for. This field is required if the other conditionally required fields are left empty.FleetNameStringConditionallyThe fleet name associated with the driver. This field is required if the other conditionally required fields are left empty.IsActiveBooleanConditionallyWhether to filter by active drivers. </Table>

Example CURL request

Use the Current API version number and make sure to replace the Authorization header value with your actual Bearer token for the request:

curl --location 'https://integrations.alvys.com/api/p/v1/drivers/search' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkplA' \
--header 'Content-Type: application/json' \
--data '{
  "Page": 0,
  "PageSize": 50,
  "Status": [
    "OFF DUTY"
  ],
  "Name": "",
  "EmployeeId": "",
  "FleetName": "",
  "IsActive": true
}'

Response Parameters

The following table lists the parameters included in the response for driver search requests:

Parameter	Type	Description
Page	Integer	The current page number of the results.
PageSize	Integer	The number of results per page.
Total	Integer	The total number of matching drivers.
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"

Body

Page

integer<int32>

required

PageSize

integer<int32>

required

Status

string[] | null

Name

string | null

EmployeeId

string | null

FleetName

string | null

IsActive

boolean | null

Response

Page

integer<int32>

required

PageSize

integer<int32>

required

Total

integer<int64>

required

Items

object[]

required

Show child attributes

Facets

object | null

Show child attributes

⌘I

Search drivers

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/drivers/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "Page": 123,
  "PageSize": 123,
  "Status": [
    "<string>"
  ],
  "Name": "<string>",
  "EmployeeId": "<string>",
  "FleetName": "<string>",
  "IsActive": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Page: 123,
    PageSize: 123,
    Status: ['<string>'],
    Name: '<string>',
    EmployeeId: '<string>',
    FleetName: '<string>',
    IsActive: true
  })
};

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

import requests

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

payload = {
    "Page": 123,
    "PageSize": 123,
    "Status": ["<string>"],
    "Name": "<string>",
    "EmployeeId": "<string>",
    "FleetName": "<string>",
    "IsActive": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/drivers/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Page' => 123,
    'PageSize' => 123,
    'Status' => [
        '<string>'
    ],
    'Name' => '<string>',
    'EmployeeId' => '<string>',
    'FleetName' => '<string>',
    'IsActive' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"Status\": [\n    \"<string>\"\n  ],\n  \"Name\": \"<string>\",\n  \"EmployeeId\": \"<string>\",\n  \"FleetName\": \"<string>\",\n  \"IsActive\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integrations.alvys.com/api/p/v{version}/drivers/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"Status\": [\n    \"<string>\"\n  ],\n  \"Name\": \"<string>\",\n  \"EmployeeId\": \"<string>\",\n  \"FleetName\": \"<string>\",\n  \"IsActive\": true\n}")
  .asString();

{
  "Page": 123,
  "PageSize": 123,
  "Total": 123,
  "Items": [
    {
      "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>"
        }
      ]
    }
  ],
  "Facets": {}
}

{
  "Errors": {},
  "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>"
}

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

​Request Parameters

​Body Request

​Example CURL request

​Response Parameters

​Example Response

​Rate Limits

Authorizations

Path Parameters

Body

Response

Request Parameters

Body Request

Example CURL request

Response Parameters

Example Response

Rate Limits