Guides
Changelog
Back to All
Added

Custom References for Trips, Drivers, Trucks & Trailers

6 months ago

Release Date: January–February 2026

What's New?

Custom references — tenant-defined key/value identifiers configured in your Alvys company profile — are now exposed in the Public API on trips, drivers, trucks, and trailers.

What Changed?

Previously, custom references were only visible inside the Alvys platform.

Now, the corresponding get-by-id and search responses include a references collection:

"references": [
  {
    "id": "string",
    "referenceId": "string",
    "name": "string",
    "value": "string",
    "type": "Text",
    "access": "Public",
    "origin": "string"
  }
]

Endpoints Affected

  • GET /api/p/v{version}/trips/{id} and POST /api/p/v{version}/trips/search
  • GET /api/p/v{version}/drivers/{id} and POST /api/p/v{version}/drivers/search
  • GET /api/p/v{version}/trucks/{id} and POST /api/p/v{version}/trucks/search
  • GET /api/p/v{version}/trailers/{id} and POST /api/p/v{version}/trailers/search

Only references configured as visible to the Public API are returned — reference visibility is controlled per reference type in your company profile.

Why?

Most fleets track external identifiers that don't fit standard fields — payroll ids, ELD ids, insurance policy numbers, legacy system keys. Custom references let you model those in Alvys, and this change makes them available to every integration that needs to join Alvys records to outside systems.