List trip check calls

GET

api

{version}

trips

{tripId}

check-calls

List trip check calls

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

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

fetch('https://integrations.alvys.com/api/p/v{version}/trips/{tripId}/check-calls', 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}/trips/{tripId}/check-calls"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/trips/{tripId}/check-calls",
  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}/trips/{tripId}/check-calls"

	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>",
    "LoadNumber": "<string>",
    "Description": "<string>",
    "TripId": "<string>",
    "Location": {
      "Street": "<string>",
      "City": "<string>",
      "State": "<string>",
      "Zip": "<string>",
      "Country": "<string>",
      "Coordinates": {
        "Latitude": "<string>",
        "Longitude": "<string>"
      },
      "TimeZoneId": "<string>"
    },
    "CreatedAt": "2023-11-07T05:31:56Z",
    "Activity": "<string>",
    "ResponseType": "<string>",
    "CreatedBy": "<string>",
    "DriverName": "<string>",
    "TripNumber": "<string>",
    "SetpointTemperature": {
      "Value": 123
    },
    "ReturnTemperature": {
      "Value": 123
    }
  }
]

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

Retrieve the check calls (driver status updates) logged on a specific trip by its unique tripId, most recent first. Check calls are trip-level: a driver is assigned per trip, and each trip carries its own latest check call.

Endpoint

GET /api/p/v{version}/trips/{tripId}/check-calls

Request Parameters

Parameter	Type	Required	Description
version	String	Yes	API version to use (`1.0`).
tripId	String	Yes	Unique identifier of the trip.

Example CURL request

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

Replace {version} with 1.0, {tripId} with the actual trip ID, and YOUR_ACCESS_TOKEN with a valid token.

Response Body

Array of check-call objects:

Name	Type	Description
Id	string	Unique identifier of the check call.
LoadNumber	string	Load number the check call belongs to.
Description	string	Free-text note captured with the check call (e.g. the driver’s reply).
Location	object, null	Structured location (`Street`, `City`, `State`, `Zip`, `Country`, `Coordinates`).
CreatedAt	string, null	UTC timestamp when the check call was recorded.
Activity	string, null	The activity reported (e.g. `Driving`, `At Pickup`).
ResponseType	string, null	Categorization of the response (e.g. arrival, departure).
CreatedBy	string, null	Name of the user or integration that logged the check call.
DriverName	string, null	Assigned driver’s name, if known.
TripId	string	Id of the trip the check call belongs to.
TripNumber	string, null	Related trip number, if known.
SetpointTemperature	object, null	Reefer set-point temperature (`Value`, `Unit`).
ReturnTemperature	object, null	Reefer return temperature (`Value`, `Unit`).

Example Response (200 OK)

[
  {
    "Id": "9f1c2a7b3e4d4f8a9b0c1d2e3f4a5b6c",
    "LoadNumber": "L100245",
    "Description": "Driver reports on schedule",
    "Location": {
      "Street": "123 Main St",
      "City": "Dallas",
      "State": "TX",
      "Zip": "75001",
      "Country": "US",
      "Coordinates": { "Latitude": "32.7767", "Longitude": "-96.7970" }
    },
    "CreatedAt": "2026-07-08T15:04:07+00:00",
    "Activity": "Driving",
    "ResponseType": null,
    "CreatedBy": "public-api-tl743-integration",
    "DriverName": "Jordan Rivera",
    "TripId": "b93e5cf1b6134f5e9a78b07af2870d9b",
    "TripNumber": "T100245-1",
    "SetpointTemperature": { "Value": 34, "Unit": "Fahrenheit" },
    "ReturnTemperature": null
  }
]

Status Codes

Code	Meaning
200	Check calls returned (most recent first).
401	Missing or invalid access token.
403	Token lacks the required scope.
404	Trip not found (or not accessible to your tenant).
429	Rate limit exceeded.

Rate Limits

All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information, see the Rate Limits section.

Try It Out

This page is interactive, allowing you to try a request by specifying the API version and tripId 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. ⚠️ Don’t forget: 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

tripId

string

required

version

string

default:1.0

required

API version (e.g., 1.0)

Example:

"1.0"

Response

string

required

Unique identifier of the check call.

LoadNumber

string

required

Load number the check call belongs to.

Description

string

required

Free-text note captured with the check call.

TripId

string

required

Id of the trip the check call belongs to.

Location

object

Show child attributes

CreatedAt

string<date-time> | null

When the check call was recorded (UTC).

Activity

string | null

The activity reported.

ResponseType

string | null

Categorization of the response (e.g. arrival, departure).

CreatedBy

string | null

Name of the user or integration that logged the check call.

DriverName

string | null

Assigned driver's name, if known.

TripNumber

string | null

Related trip number, if known.

SetpointTemperature

object

Show child attributes

ReturnTemperature

object

Show child attributes

⌘I

List trip check calls

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

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

fetch('https://integrations.alvys.com/api/p/v{version}/trips/{tripId}/check-calls', 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}/trips/{tripId}/check-calls"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/trips/{tripId}/check-calls",
  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}/trips/{tripId}/check-calls"

	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>",
    "LoadNumber": "<string>",
    "Description": "<string>",
    "TripId": "<string>",
    "Location": {
      "Street": "<string>",
      "City": "<string>",
      "State": "<string>",
      "Zip": "<string>",
      "Country": "<string>",
      "Coordinates": {
        "Latitude": "<string>",
        "Longitude": "<string>"
      },
      "TimeZoneId": "<string>"
    },
    "CreatedAt": "2023-11-07T05:31:56Z",
    "Activity": "<string>",
    "ResponseType": "<string>",
    "CreatedBy": "<string>",
    "DriverName": "<string>",
    "TripNumber": "<string>",
    "SetpointTemperature": {
      "Value": 123
    },
    "ReturnTemperature": {
      "Value": 123
    }
  }
]

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

​Endpoint

​Request Parameters

​Example CURL request

​Response Body

​Example Response (200 OK)

​Status Codes

​Rate Limits

​Try It Out

Authorizations

Path Parameters

Response

Endpoint

Request Parameters

Example CURL request

Response Body

Example Response (200 OK)

Status Codes

Rate Limits

Try It Out