Partners

Maintenance items mapped to VIA; each object uses keys accepted by the inbound maintenance mapper (camelCase; PascalCase alts in code for id/created/name/due*).

Notes for the tractor

Tractors - Create Tractor › Responses

The created tractor.

id

integer · int32

tractorNumber

string

dataGUID

string

tractorType

string

tractorType1

string

tractorType2

string

tractorType3

string

tractorType4

string

lastContactCity

string

lastContactState

string

lastContactZipCode

string

lastContactLatitude

string

lastContactLongitude

string

lastContactDate

string

lastContactTime

string

tractorLastContactProximity

string

lastContactDateTime

string · date-time

etaCity

string

etaState

string

etaZipCode

string

etaLatitude

string

etaLongitude

string

etaDate

string

etaTime

string

etaDateTime

string · date-time

licensePlate

string

serialNumber

string

vehicleGroupId

string

lastContactProximityDescription

string

terminatedDate

string · date-time

terminalId

string

tractorMake

string

tractorModel

string

tractorYear

integer · int32

tractorStatus

string

mobileCommID

string

odometer

number · double

totalHours

number · double

alternateId

string

currentDriverId

string

lastMessageTimestamp

string · date-time

dieselHours

number · double

electricHours

number · double

licenseState

string

terminalName

string

expirationDate

string

Maintenance records for the tractor

Notes associated with the tractor

POST/v1/partner/{partnercode}/tractors

curl https://carriercloud.ai/v1/partner/:partnercode/tractors \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "tractorNumber": "TRK-818",
  "tractorType1": "sleeper",
  "tractorType2": "doubles",
  "tractorMake": "Freightliner",
  "tractorModel": "Cascadia",
  "tractorYear": 2019,
  "tractorStatus": "Available",
  "lastContactDateTime": "2026-04-23T12:00:00Z",
  "lastContactCity": "Dallas",
  "lastContactState": "TX",
  "tractorLastContactProximity": "2mi",
  "licensePlate": "TEX-4L88",
  "serialNumber": "1FUJGHDV0LSBVA00",
  "licenseState": "TX",
  "mobileCommID": "MC-001",
  "odometer": 125430.5,
  "maintenance": [
    {
      "id": "maint-tractor-1",
      "name": "DOT annual inspection",
      "dueIn": 45,
      "dueInUnit": "days",
      "dueDate": "2026-06-15T00:00:00Z",
      "created": "2025-12-01T00:00:00Z"
    }
  ],
  "notes": [
    {
      "note": "Haul This",
      "viaNoteType": "Special Instructions"
    }
  ]
}'

Example Request Body

{
  "tractorNumber": "TRK-818",
  "tractorType1": "sleeper",
  "tractorType2": "doubles",
  "tractorMake": "Freightliner",
  "tractorModel": "Cascadia",
  "tractorYear": 2019,
  "tractorStatus": "Available",
  "lastContactDateTime": "2026-04-23T12:00:00Z",
  "lastContactCity": "Dallas",
  "lastContactState": "TX",
  "tractorLastContactProximity": "2mi",
  "licensePlate": "TEX-4L88",
  "serialNumber": "1FUJGHDV0LSBVA00",
  "licenseState": "TX",
  "mobileCommID": "MC-001",
  "odometer": 125430.5,
  "maintenance": [
    {
      "id": "maint-tractor-1",
      "name": "DOT annual inspection",
      "dueIn": 45,
      "dueInUnit": "days",
      "dueDate": "2026-06-15T00:00:00Z",
      "created": "2025-12-01T00:00:00Z"
    }
  ],
  "notes": [
    {
      "note": "Haul This",
      "viaNoteType": "Special Instructions"
    }
  ]
}

json

Sample request body

application/json

Example Responses

{
  "dataGUID": "trk-5f1c2a",
  "tractorNumber": "1412",
  "tractorType1": "Sleeper",
  "tractorStatus": "Available",
  "tractorMake": "Freightliner",
  "tractorModel": "Cascadia",
  "tractorYear": 2023,
  "licensePlate": "PWX8812",
  "licenseState": "OH",
  "serialNumber": "1FUJGLDR5CSBH1234",
  "lastContactDateTime": "2026-10-01T13:42:10.000Z",
  "lastContactCity": "Findlay",
  "lastContactState": "OH",
  "tractorLastContactProximity": "3.2mi S of Findlay, OH",
  "odometer": 412887,
  "maintenance": [
    {
      "name": "Oil change",
      "dueIn": 1800,
      "dueInUnit": "miles",
      "dueDate": "2026-10-20T00:00:00Z"
    }
  ],
  "notes": [
    {
      "dataGUID": "note-1",
      "note": "Assigned to Linehaul",
      "viaNoteType": "Special Instructions"
    }
  ]
}

json

application/json

Drivers - Get Driver

GET

https://carriercloud.ai

/v1/partner/{partnercode}/drivers/{driverid}

Get a single driver for the partner by driver id.

Drivers - Get Driver › path Parameters

partnercode

string · required

driverid

string · required

Driver identifier as returned by Get Drivers.

Drivers - Get Driver › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Drivers - Get Driver › Responses

The driver as a one-element array.

object[]

Driver record returned by Get Drivers and Get Driver.

ID

string | null

Driver card identifier; use it as driverid.

DataGUID

string | null

DriverId

string | null

Driver code in the partner's system.

DriverName

string | null

Status

string | null

BirthDate

string | null · date

Address

string | null

City

string | null

State

string | null

County

string | null

Country (historical field name).

LastContactLatitude

number | null

LastContactLongitude

number | null

LastContactProximity

string | null

LicenseExpireDate

string | null · date

LicenseNumber

string | null

LicenseState

string | null

Phone

string | null

MobilePhone

string | null

TerminatedDate

string | null · date

FirstName

string | null

MiddleName

string | null

LastName

string | null

Email

string | null · email

Gender

string | null

CreationDate

string | null · date-time

GET/v1/partner/{partnercode}/drivers/{driverid}

curl https://carriercloud.ai/v1/partner/:partnercode/drivers/:driverid \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "ID": "drv-2a9e11",
    "DataGUID": "drv-2a9e11",
    "DriverId": "JSMITH",
    "DriverName": "John Smith",
    "Status": "Active",
    "BirthDate": null,
    "Address": "12 Maple St",
    "City": "Perrysburg",
    "State": "OH",
    "County": "USA",
    "LastContactLatitude": 40.996,
    "LastContactLongitude": -83.65,
    "LastContactProximity": "3.2mi S of Findlay, OH",
    "LicenseExpireDate": "2028-03-31",
    "LicenseNumber": null,
    "LicenseState": "OH",
    "Phone": null,
    "MobilePhone": "419-555-0142",
    "TerminatedDate": null,
    "FirstName": "John",
    "MiddleName": null,
    "LastName": "Smith",
    "Email": "[email protected]",
    "Gender": null,
    "CreationDate": "2024-02-14T16:03:00.000Z"
  }
]

json

application/json

Drivers - Get Drivers

GET

https://carriercloud.ai

/v1/partner/{partnercode}/drivers

Returns a list of active drivers for a specific partner.

Drivers - Get Drivers › path Parameters

partnercode

string · required

Drivers - Get Drivers › query Parameters

page

integer · int32

Page number to return, starting at 1. Omit for the first page.

Drivers - Get Drivers › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Drivers - Get Drivers › Responses

Drivers for the partner, 100 per page.

object[]

Driver record returned by Get Drivers and Get Driver.

ID

string | null

Driver card identifier; use it as driverid.

DataGUID

string | null

DriverId

string | null

Driver code in the partner's system.

DriverName

string | null

Status

string | null

BirthDate

string | null · date

Address

string | null

City

string | null

State

string | null

County

string | null

Country (historical field name).

LastContactLatitude

number | null

LastContactLongitude

number | null

LastContactProximity

string | null

LicenseExpireDate

string | null · date

LicenseNumber

string | null

LicenseState

string | null

Phone

string | null

MobilePhone

string | null

TerminatedDate

string | null · date

FirstName

string | null

MiddleName

string | null

LastName

string | null

Email

string | null · email

Gender

string | null

CreationDate

string | null · date-time

GET/v1/partner/{partnercode}/drivers

curl https://carriercloud.ai/v1/partner/:partnercode/drivers \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "ID": "drv-2a9e11",
    "DataGUID": "drv-2a9e11",
    "DriverId": "JSMITH",
    "DriverName": "John Smith",
    "Status": "Active",
    "BirthDate": null,
    "Address": "12 Maple St",
    "City": "Perrysburg",
    "State": "OH",
    "County": "USA",
    "LastContactLatitude": 40.996,
    "LastContactLongitude": -83.65,
    "LastContactProximity": "3.2mi S of Findlay, OH",
    "LicenseExpireDate": "2028-03-31",
    "LicenseNumber": null,
    "LicenseState": "OH",
    "Phone": null,
    "MobilePhone": "419-555-0142",
    "TerminatedDate": null,
    "FirstName": "John",
    "MiddleName": null,
    "LastName": "Smith",
    "Email": "[email protected]",
    "Gender": null,
    "CreationDate": "2024-02-14T16:03:00.000Z"
  }
]

json

application/json

Drivers - Get Hours of Service

GET

https://carriercloud.ai

/v1/partner/{partnercode}/drivers/hos/{date}

Retrieve Hours of Service (ELD) information for a driver.

Drivers - Get Hours of Service › path Parameters

partnercode

string · required

date

string · date · required

Calendar date in YYYY-MM-DD form. Hours of service are returned for this day.

Drivers - Get Hours of Service › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Drivers - Get Hours of Service › Responses

Hours-of-service records for the partner's drivers on the given date.

Upstream result; the field set is not published and may change. Treat the HTTP status as the outcome.

Tractors - Get GPS Positions

GET

https://carriercloud.ai

/v1/partner/{partnercode}/tractors/{tractorguid}/positions

Get historical positions for a specific tractor (vehicle).

Tractors - Get GPS Positions › path Parameters

partnercode

string · required

tractorguid

string · required

Tractor identifier as returned by Get Tractors (the id field of a tractor).

Tractors - Get GPS Positions › query Parameters

page

integer · int32

Page number to return, starting at 1. Omit for the first page.

startdate

string · date-time

Only return records changed on or after this UTC date-time (ISO 8601).

Tractors - Get GPS Positions › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Tractors - Get GPS Positions › Responses

Positions recorded for the tractor since fromDateTime.

object[] · required

Newest positions, at most 100 per call.

moreAvailable

boolean · required

True when more positions exist than were returned; narrow the time window to see them.

GET/v1/partner/{partnercode}/tractors/{tractorguid}/positions

curl https://carriercloud.ai/v1/partner/:partnercode/tractors/:tractorguid/positions \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "positions": [
    {
      "EquipmentType": 3,
      "EquipmentId": "1412",
      "Driver": null,
      "PosDescription": "3.2mi S of Findlay, OH",
      "PosDateTime": "2026-10-01T13:42:10.000Z",
      "TimeZoneOffset": "+00:00",
      "Latitude": "40.99600",
      "Longitude": "-83.65000",
      "GPSMileage": 412887,
      "Speed": 62,
      "SpeedUnit": "mph",
      "NetworkId": null,
      "FuelLevelPct": null,
      "FuelPctType": null,
      "PosDescriptionCity": "Findlay",
      "PosDescriptionState": "OH"
    },
    {
      "EquipmentType": 3,
      "EquipmentId": "1412",
      "Driver": null,
      "PosDescription": "1.0mi N of Bowling Green, OH",
      "PosDateTime": "2026-10-01T13:27:10.000Z",
      "TimeZoneOffset": "+00:00",
      "Latitude": "41.21100",
      "Longitude": "-83.65400",
      "GPSMileage": 412887,
      "Speed": 64,
      "SpeedUnit": "mph",
      "NetworkId": null,
      "FuelLevelPct": null,
      "FuelPctType": null,
      "PosDescriptionCity": "Bowling Green",
      "PosDescriptionState": "OH"
    }
  ],
  "moreAvailable": false
}

json

application/json

Tractors - Get Performance Events

GET

https://carriercloud.ai

/v1/partner/{partnercode}/tractors/{tractorguid}/Event

Get historical performance events for a specific tractor (vehicle).

Tractors - Get Performance Events › path Parameters

partnercode

string · required

tractorguid

string · required

Tractor identifier as returned by Get Tractors (the id field of a tractor).

Tractors - Get Performance Events › query Parameters

page

integer · int32

Page number to return, starting at 1. Omit for the first page.

startdate

string · date-time

Only return records changed on or after this UTC date-time (ISO 8601).

Tractors - Get Performance Events › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Tractors - Get Performance Events › Responses

Performance events for the tractor, newest first.

object[]

A telematics performance summary for a tractor, as reported by the connected ELD. Times are in seconds, distances in the provider's unit, fuel in gallons unless the provider says otherwise.

DateTime

string | null · date-time

Date-time of the event (UTC).

MessageID

string | null

Event identifier.

DriverId

string | null

Driver card identifier.

TruckNumber

string | null

Tractor card identifier.

VINNumber

string | null

Always null.

SerialNumber

string | null

Always null.

IdleThreshold

number | null

RPMThreshold

number | null

OverSpeedThreshold

number | null

ExcessSpeedThreshold

number | null

StartOdometer

number | null

EndOdometer

number | null

EngineRunTime

number | null

DriveTime

number | null

MovingTime

number | null

OverRPMTime

number | null

OverRPMCount

number | null

OverRPMMax

number | null

OverSpeedTime

number | null

OverSpeedCount

number | null

OverSpeedMax

number | null

LongIdleTime

number | null

LongIdleCount

number | null

LongIdleFuelUsed

number | null

ShortIdleTime

number | null

ShortIdleCount

number | null

ShortIdleFuelUsed

number | null

CurrentFuel

number | null

StartFuel

number | null

EndFuel

number | null

PTOTime

number | null

PTOFuel

number | null

CruiseEvents

number | null

CruiseTime

number | null

CruiseFuel

number | null

CruiseDistance

number | null

TopGear

number | null

TopGearTime

number | null

TopGearFuel

number | null

TopGearDistance

number | null

GearDataSource

string | null

SeatBeltTime

number | null

BrakeEvents

number | null

EngineLoadStopped

number | null

EngineLoadMoving

number | null

FuelLevelTank1

number | null

FuelLevelTank2

number | null

HeadlightTime

number | null

SpeedSetting

number | null

FilterStatus

number | null

DEFLevel

number | null

OverSpeedHighTime

number | null

OverSpeedLowTime

number | null

StartNG

number | null

EndNG

number | null

StartDiesel

number | null

EndDiesel

number | null

TractorTerminalId

string

Always empty.

TractorOwnerOperated

string

Always empty.

SpeedMaxValue

number | null

HardAccelerationCount

number | null

HarshCorneringCount

number | null

AccelerationMaxValue

number | null

DecelerationMaxValue

number | null

SideAccelerationMaxValue

number | null

GET/v1/partner/{partnercode}/tractors/{tractorguid}/Event

curl https://carriercloud.ai/v1/partner/:partnercode/tractors/:tractorguid/Event \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "DateTime": "2026-09-30T23:59:59.000Z",
    "MessageID": "perf-91ab2c",
    "DriverId": "drv-2a9e11",
    "TruckNumber": "trk-5f1c2a",
    "VINNumber": null,
    "SerialNumber": null,
    "IdleThreshold": 300,
    "RPMThreshold": 1800,
    "OverSpeedThreshold": 1800,
    "ExcessSpeedThreshold": 75,
    "StartOdometer": 412401,
    "EndOdometer": 412887,
    "EngineRunTime": 36120,
    "DriveTime": 31560,
    "MovingTime": 30900,
    "OverRPMTime": 120,
    "OverRPMCount": 3,
    "OverRPMMax": 1910,
    "OverSpeedTime": 240,
    "OverSpeedCount": 2,
    "OverSpeedMax": 71,
    "LongIdleTime": 1800,
    "LongIdleCount": 2,
    "LongIdleFuelUsed": 0.9,
    "ShortIdleTime": 600,
    "ShortIdleCount": 9,
    "ShortIdleFuelUsed": 0.3,
    "CurrentFuel": 61.2,
    "StartFuel": 128,
    "EndFuel": 61.2,
    "PTOTime": 0,
    "PTOFuel": 0,
    "CruiseEvents": 14,
    "CruiseTime": 21000,
    "CruiseFuel": 44.1,
    "CruiseDistance": 352,
    "TopGear": 12,
    "TopGearTime": 26400,
    "TopGearFuel": 52,
    "TopGearDistance": 421,
    "GearDataSource": "ECM",
    "SeatBeltTime": 31500,
    "BrakeEvents": 88,
    "EngineLoadStopped": 12.5,
    "EngineLoadMoving": 48.2,
    "FuelLevelTank1": 48,
    "FuelLevelTank2": null,
    "HeadlightTime": 9000,
    "SpeedSetting": 68,
    "FilterStatus": null,
    "DEFLevel": 71,
    "OverSpeedHighTime": 60,
    "OverSpeedLowTime": 180,
    "StartNG": null,
    "EndNG": null,
    "StartDiesel": 128,
    "EndDiesel": 61.2,
    "TractorTerminalId": "",
    "TractorOwnerOperated": "",
    "SpeedMaxValue": 71,
    "HardAccelerationCount": 1,
    "HarshCorneringCount": 0,
    "AccelerationMaxValue": 0.31,
    "DecelerationMaxValue": 0.42,
    "SideAccelerationMaxValue": 0.22
  }
]

json

application/json

Locations - Delete Location

DELETE

https://carriercloud.ai

/v1/partner/{partnercode}/locations/{id}

Archive (delete) a location card by id.

Locations - Delete Location › path Parameters

partnercode

string · required

id

string · required

The location card id

Locations - Delete Location › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Locations - Delete Location › Responses

Success

No data returned

Locations - Disable Location Role

DELETE

https://carriercloud.ai

/v1/partner/{partnercode}/locations/{id}/roles/{role}

Disables the specified role on a partner location card. Warning: Removing a role permanently deletes all data associated with that role (role-specific address and contact fields, required attributes, hours of operation, billing settings, etc.). This action cannot be undone via the API.

Locations - Disable Location Role › path Parameters

partnercode

string · required

id

string · required

The location card id

role

string · enum · required

Location role to disable

Enum values:

Shipper

Consignee

BillTo

Terminal

TruckStop

Agent

WashFacility

Locations - Disable Location Role › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Locations - Disable Location Role › Responses

Success

No data returned

Trailers - Get by Id

GET

https://carriercloud.ai

/v1/partner/{partnercode}/trailers/{id}

Get a trailer by id

Trailers - Get by Id › path Parameters

partnercode

string · required

id

string · required

The trailer card id

Trailers - Get by Id › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Trailers - Get by Id › Responses

The trailer. Keys the platform has no value for are omitted.

TrailerActor

id

integer · int32

trailerId

string

dataGUID

string

trailerNumber

string

trailerModel

string

trailerMake

string

trailerOwner

string

trailerType1

string

trailerType2

string

trailerType3

string

trailerType4

string

trailerYear

integer · int32

trailerCompanyId

string

trailerStatus

string

trailerLastContactLat

string

trailerLastContactLng

string

trailerLastContactProximity

string

lastContactedDateTime

string · date-time

trailerLastContactCity

string

trailerLastContactState

string

trailerLastContactCountry

string

trailerLastContactDirection

string

zone1SetPoint

number · double

zone1ReturnAir

number · double

zone2SetPoint

number · double

zone2ReturnAir

number · double

zone3SetPoint

number · double

zone3ReturnAir

number · double

batteryVoltage

number · double

fuelLevel

number · double

operatingMode

string

moving

boolean

refrigerationRunning

boolean

lastUpdated

string · date-time

licensePlate

string

terminatedDate

string · date-time

mobileCommID

string

odometer

number · double

totalHours

number · double

dieselHours

number · double

electricHours

number · double

licenseState

string

terminalId

string

terminalName

string

zone1Discharge

number · double

zone2Discharge

number · double

zone3Discharge

number · double

sensor1

number · double

sensor2

number · double

sensor3

number · double

sensor4

number · double

sensor5

number · double

sensor6

number · double

expirationDate

string

mobileComStatus

string

unitMode

string

zone1AuxiliaryTemp

number · double

zone2AuxiliaryTemp

number · double

zone3AuxiliaryTemp

number · double

zone1SupplyAir

number · double

zone2SupplyAir

number · double

zone3SupplyAir

number · double

zone1OperatingMode

string

zone2OperatingMode

string

zone3OperatingMode

string

ambientTemp

number · double

receivedDateTime

string · date-time

division

string

fleet

string

additionalValues

string[]

Maintenance records for the trailer

Notes associated with the trailer

GET/v1/partner/{partnercode}/trailers/{id}

curl https://carriercloud.ai/v1/partner/:partnercode/trailers/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "dataGUID": "trl-0c44a9",
  "trailerId": "T-5531",
  "trailerNumber": "5531",
  "trailerModel": "Dry Van 53",
  "trailerMake": "Wabash",
  "trailerType1": "Van",
  "trailerYear": 2021,
  "trailerStatus": "empty",
  "trailerLastContactLat": "41.5335",
  "trailerLastContactLng": "-83.6236",
  "trailerLastContactProximity": "Perrysburg, OH",
  "lastContactedDateTime": "2026-10-01T09:10:00.000Z",
  "trailerLastContactCity": "Perrysburg",
  "trailerLastContactState": "OH",
  "licensePlate": "TRL5531",
  "licenseState": "OH",
  "terminalId": "PBG",
  "notes": [
    {
      "dataGUID": "note-2",
      "note": "Reefer unit serviced 9/12",
      "viaNoteType": "Maintenance"
    }
  ]
}

json

application/json

Trailers - Update Trailer

PUT

https://carriercloud.ai

/v1/partner/{partnercode}/trailers/{id}

Update a trailer by id

Trailers - Update Trailer › path Parameters

partnercode

string · required

id

string · required

The trailer card id

Trailers - Update Trailer › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Trailers - Update Trailer › Request Body optional

Create trailer: fields accepted and mapped to the carrier API (see trailer-actor-to-trailer-card-payload).

TrailerRequestBody

trailerId

string

trailerNumber

string

trailerModel

string

trailerMake

string

trailerOwner

string

trailerType1

string

trailerType2

string

trailerType3

string

trailerType4

string

trailerYear

integer · int32

trailerCompanyId

string

trailerStatus

string

trailerLastContactLat

string

trailerLastContactLng

string

trailerLastContactProximity

string

lastContactedDateTime

string · date-time

trailerLastContactCity

string

trailerLastContactState

string

licensePlate

string

licenseState

string

terminalId

string

Maintenance records for the trailer

Notes for the trailer; mapped inbound to TripNotes for the partner API

Trailers - Update Trailer › Responses

The updated trailer.

TrailerActor

id

integer · int32

trailerId

string

dataGUID

string

trailerNumber

string

trailerModel

string

trailerMake

string

trailerOwner

string

trailerType1

string

trailerType2

string

trailerType3

string

trailerType4

string

trailerYear

integer · int32

trailerCompanyId

string

trailerStatus

string

trailerLastContactLat

string

trailerLastContactLng

string

trailerLastContactProximity

string

lastContactedDateTime

string · date-time

trailerLastContactCity

string

trailerLastContactState

string

trailerLastContactCountry

string

trailerLastContactDirection

string

zone1SetPoint

number · double

zone1ReturnAir

number · double

zone2SetPoint

number · double

zone2ReturnAir

number · double

zone3SetPoint

number · double

zone3ReturnAir

number · double

batteryVoltage

number · double

fuelLevel

number · double

operatingMode

string

moving

boolean

refrigerationRunning

boolean

lastUpdated

string · date-time

licensePlate

string

terminatedDate

string · date-time

mobileCommID

string

odometer

number · double

totalHours

number · double

dieselHours

number · double

electricHours

number · double

licenseState

string

terminalId

string

terminalName

string

zone1Discharge

number · double

zone2Discharge

number · double

zone3Discharge

number · double

sensor1

number · double

sensor2

number · double

sensor3

number · double

sensor4

number · double

sensor5

number · double

sensor6

number · double

expirationDate

string

mobileComStatus

string

unitMode

string

zone1AuxiliaryTemp

number · double

zone2AuxiliaryTemp

number · double

zone3AuxiliaryTemp

number · double

zone1SupplyAir

number · double

zone2SupplyAir

number · double

zone3SupplyAir

number · double

zone1OperatingMode

string

zone2OperatingMode

string

zone3OperatingMode

string

ambientTemp

number · double

receivedDateTime

string · date-time

division

string

fleet

string

additionalValues

string[]

Maintenance records for the trailer

Notes associated with the trailer

PUT/v1/partner/{partnercode}/trailers/{id}

curl https://carriercloud.ai/v1/partner/:partnercode/trailers/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "trailerId": "1001",
  "trailerNumber": "TRL-10042",
  "trailerModel": "Dry Van 53ft",
  "trailerMake": "Wabash",
  "trailerOwner": "Acme Transport",
  "trailerType1": "van",
  "trailerType2": "food-grade",
  "trailerType3": "refrigerated",
  "trailerType4": "53ft",
  "trailerYear": 2018,
  "trailerCompanyId": "acme-tenant-1",
  "trailerStatus": "empty",
  "trailerLastContactLat": "32.7767",
  "trailerLastContactLng": "-96.7970",
  "trailerLastContactProximity": "0.5mi",
  "lastContactedDateTime": "2026-04-23T12:00:00Z",
  "trailerLastContactCity": "Dallas",
  "trailerLastContactState": "TX",
  "licensePlate": "TEX-9K2",
  "licenseState": "TX",
  "terminalId": "DFW-01",
  "maintenance": [
    {
      "id": "maint-1",
      "name": "Annual DOT inspection",
      "dueIn": 90,
      "dueInUnit": "days",
      "dueDate": "2026-07-23T00:00:00Z",
      "created": "2025-12-01T00:00:00Z"
    }
  ],
  "notes": [
    {
      "note": "Deliver to the back of the building",
      "viaNoteType": "Special Instructions"
    }
  ]
}'

Example Request Body

{
  "trailerId": "1001",
  "trailerNumber": "TRL-10042",
  "trailerModel": "Dry Van 53ft",
  "trailerMake": "Wabash",
  "trailerOwner": "Acme Transport",
  "trailerType1": "van",
  "trailerType2": "food-grade",
  "trailerType3": "refrigerated",
  "trailerType4": "53ft",
  "trailerYear": 2018,
  "trailerCompanyId": "acme-tenant-1",
  "trailerStatus": "empty",
  "trailerLastContactLat": "32.7767",
  "trailerLastContactLng": "-96.7970",
  "trailerLastContactProximity": "0.5mi",
  "lastContactedDateTime": "2026-04-23T12:00:00Z",
  "trailerLastContactCity": "Dallas",
  "trailerLastContactState": "TX",
  "licensePlate": "TEX-9K2",
  "licenseState": "TX",
  "terminalId": "DFW-01",
  "maintenance": [
    {
      "id": "maint-1",
      "name": "Annual DOT inspection",
      "dueIn": 90,
      "dueInUnit": "days",
      "dueDate": "2026-07-23T00:00:00Z",
      "created": "2025-12-01T00:00:00Z"
    }
  ],
  "notes": [
    {
      "note": "Deliver to the back of the building",
      "viaNoteType": "Special Instructions"
    }
  ]
}

json

Sample request body

application/json

Example Responses

{
  "dataGUID": "trl-0c44a9",
  "trailerId": "T-5531",
  "trailerNumber": "5531",
  "trailerModel": "Dry Van 53",
  "trailerMake": "Wabash",
  "trailerType1": "Van",
  "trailerYear": 2021,
  "trailerStatus": "empty",
  "trailerLastContactLat": "41.5335",
  "trailerLastContactLng": "-83.6236",
  "trailerLastContactProximity": "Perrysburg, OH",
  "lastContactedDateTime": "2026-10-01T09:10:00.000Z",
  "trailerLastContactCity": "Perrysburg",
  "trailerLastContactState": "OH",
  "licensePlate": "TRL5531",
  "licenseState": "OH",
  "terminalId": "PBG",
  "notes": [
    {
      "dataGUID": "note-2",
      "note": "Reefer unit serviced 9/12",
      "viaNoteType": "Maintenance"
    }
  ]
}

json

application/json

Trailers - Delete Trailer

DELETE

https://carriercloud.ai

/v1/partner/{partnercode}/trailers/{id}

Delete a trailer by id

Trailers - Delete Trailer › path Parameters

partnercode

string · required

id

string · required

The trailer card id

Trailers - Delete Trailer › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Trailers - Delete Trailer › Responses

Success

No data returned

Trailers - Get by Trailer Number

GET

https://carriercloud.ai

/v1/partner/{partnercode}/trailers/byNumber/{trailerNumber}

Get trailer by trailer number

Trailers - Get by Trailer Number › path Parameters

partnercode

string · required

trailerNumber

string · required

Trailer number to look up.

Trailers - Get by Trailer Number › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Trailers - Get by Trailer Number › Responses

Trailers matching the number.

TrailerActor[]

TrailerActor

id

integer · int32

trailerId

string

dataGUID

string

trailerNumber

string

trailerModel

string

trailerMake

string

trailerOwner

string

trailerType1

string

trailerType2

string

trailerType3

string

trailerType4

string

trailerYear

integer · int32

trailerCompanyId

string

trailerStatus

string

trailerLastContactLat

string

trailerLastContactLng

string

trailerLastContactProximity

string

lastContactedDateTime

string · date-time

trailerLastContactCity

string

trailerLastContactState

string

trailerLastContactCountry

string

trailerLastContactDirection

string

zone1SetPoint

number · double

zone1ReturnAir

number · double

zone2SetPoint

number · double

zone2ReturnAir

number · double

zone3SetPoint

number · double

zone3ReturnAir

number · double

batteryVoltage

number · double

fuelLevel

number · double

operatingMode

string

moving

boolean

refrigerationRunning

boolean

lastUpdated

string · date-time

licensePlate

string

terminatedDate

string · date-time

mobileCommID

string

odometer

number · double

totalHours

number · double

dieselHours

number · double

electricHours

number · double

licenseState

string

terminalId

string

terminalName

string

zone1Discharge

number · double

zone2Discharge

number · double

zone3Discharge

number · double

sensor1

number · double

sensor2

number · double

sensor3

number · double

sensor4

number · double

sensor5

number · double

sensor6

number · double

expirationDate

string

mobileComStatus

string

unitMode

string

zone1AuxiliaryTemp

number · double

zone2AuxiliaryTemp

number · double

zone3AuxiliaryTemp

number · double

zone1SupplyAir

number · double

zone2SupplyAir

number · double

zone3SupplyAir

number · double

zone1OperatingMode

string

zone2OperatingMode

string

zone3OperatingMode

string

ambientTemp

number · double

receivedDateTime

string · date-time

division

string

fleet

string

additionalValues

string[]

Maintenance records for the trailer

Notes associated with the trailer

GET/v1/partner/{partnercode}/trailers/byNumber/{trailerNumber}

curl https://carriercloud.ai/v1/partner/:partnercode/trailers/byNumber/:trailerNumber \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "dataGUID": "trl-0c44a9",
    "trailerId": "T-5531",
    "trailerNumber": "5531",
    "trailerModel": "Dry Van 53",
    "trailerMake": "Wabash",
    "trailerType1": "Van",
    "trailerYear": 2021,
    "trailerStatus": "empty",
    "trailerLastContactLat": "41.5335",
    "trailerLastContactLng": "-83.6236",
    "trailerLastContactProximity": "Perrysburg, OH",
    "lastContactedDateTime": "2026-10-01T09:10:00.000Z",
    "trailerLastContactCity": "Perrysburg",
    "trailerLastContactState": "OH",
    "licensePlate": "TRL5531",
    "licenseState": "OH",
    "terminalId": "PBG",
    "notes": [
      {
        "dataGUID": "note-2",
        "note": "Reefer unit serviced 9/12",
        "viaNoteType": "Maintenance"
      }
    ]
  }
]

json

application/json

Trailers - Create Trailer

POST

https://carriercloud.ai

/v1/partner/{partnercode}/trailers

Create a trailer

Trailers - Create Trailer › path Parameters

partnercode

string · required

Trailers - Create Trailer › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Trailers - Create Trailer › Request Body optional

Create trailer: fields accepted and mapped to the carrier API (see trailer-actor-to-trailer-card-payload).

TrailerRequestBody

trailerId

string

trailerNumber

string

trailerModel

string

trailerMake

string

trailerOwner

string

trailerType1

string

trailerType2

string

trailerType3

string

trailerType4

string

trailerYear

integer · int32

trailerCompanyId

string

trailerStatus

string

trailerLastContactLat

string

trailerLastContactLng

string

trailerLastContactProximity

string

lastContactedDateTime

string · date-time

trailerLastContactCity

string

trailerLastContactState

string

licensePlate

string

licenseState

string

terminalId

string

Maintenance records for the trailer

Notes for the trailer; mapped inbound to TripNotes for the partner API

Trailers - Create Trailer › Responses

The created trailer card.

The created card after permission filtering.

_id

string

title

string | null

description

string | null

cardtype

string

listId

string | null

boardId

string | null

companyId

string | null

The partner company the card was created on.

object

POST/v1/partner/{partnercode}/trailers

curl https://carriercloud.ai/v1/partner/:partnercode/trailers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "trailerId": "1001",
  "trailerNumber": "TRL-10042",
  "trailerModel": "Dry Van 53ft",
  "trailerMake": "Wabash",
  "trailerOwner": "Acme Transport",
  "trailerType1": "van",
  "trailerType2": "food-grade",
  "trailerType3": "refrigerated",
  "trailerType4": "53ft",
  "trailerYear": 2018,
  "trailerCompanyId": "acme-tenant-1",
  "trailerStatus": "empty",
  "trailerLastContactLat": "32.7767",
  "trailerLastContactLng": "-96.7970",
  "trailerLastContactProximity": "0.5mi",
  "lastContactedDateTime": "2026-04-23T12:00:00Z",
  "trailerLastContactCity": "Dallas",
  "trailerLastContactState": "TX",
  "licensePlate": "TEX-9K2",
  "licenseState": "TX",
  "terminalId": "DFW-01",
  "maintenance": [
    {
      "id": "maint-1",
      "name": "Annual DOT inspection",
      "dueIn": 90,
      "dueInUnit": "days",
      "dueDate": "2026-07-23T00:00:00Z",
      "created": "2025-12-01T00:00:00Z"
    }
  ],
  "notes": [
    {
      "note": "Deliver to the back of the building",
      "viaNoteType": "Special Instructions"
    }
  ]
}'

Example Request Body

{
  "trailerId": "1001",
  "trailerNumber": "TRL-10042",
  "trailerModel": "Dry Van 53ft",
  "trailerMake": "Wabash",
  "trailerOwner": "Acme Transport",
  "trailerType1": "van",
  "trailerType2": "food-grade",
  "trailerType3": "refrigerated",
  "trailerType4": "53ft",
  "trailerYear": 2018,
  "trailerCompanyId": "acme-tenant-1",
  "trailerStatus": "empty",
  "trailerLastContactLat": "32.7767",
  "trailerLastContactLng": "-96.7970",
  "trailerLastContactProximity": "0.5mi",
  "lastContactedDateTime": "2026-04-23T12:00:00Z",
  "trailerLastContactCity": "Dallas",
  "trailerLastContactState": "TX",
  "licensePlate": "TEX-9K2",
  "licenseState": "TX",
  "terminalId": "DFW-01",
  "maintenance": [
    {
      "id": "maint-1",
      "name": "Annual DOT inspection",
      "dueIn": 90,
      "dueInUnit": "days",
      "dueDate": "2026-07-23T00:00:00Z",
      "created": "2025-12-01T00:00:00Z"
    }
  ],
  "notes": [
    {
      "note": "Deliver to the back of the building",
      "viaNoteType": "Special Instructions"
    }
  ]
}

json

Sample request body

application/json

Example Responses

{
  "_id": "trl-0c44a9",
  "title": "5531",
  "cardtype": "trailer",
  "boardId": "board-fleet",
  "listId": "list-trailers",
  "companyId": "cmp-mist",
  "carddata": {
    "TrailerNumber": "5531",
    "TrailerStatus": "empty",
    "TrailerType1": "Van",
    "TrailerYear": 2021
  }
}

json

application/json

Tractors - Get by Id

GET

https://carriercloud.ai

/v1/partner/{partnercode}/tractors/{id}

Get a tractor by id

Tractors - Get by Id › path Parameters

partnercode

string · required

id

string · required

The tractor card id

Tractors - Get by Id › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Tractors - Get by Id › Responses

The tractor. Keys the platform has no value for are omitted.

id

integer · int32

tractorNumber

string

dataGUID

string

tractorType

string

tractorType1

string

tractorType2

string

tractorType3

string

tractorType4

string

lastContactCity

string

lastContactState

string

lastContactZipCode

string

lastContactLatitude

string

lastContactLongitude

string

lastContactDate

string

lastContactTime

string

tractorLastContactProximity

string

lastContactDateTime

string · date-time

etaCity

string

etaState

string

etaZipCode

string

etaLatitude

string

etaLongitude

string

etaDate

string

etaTime

string

etaDateTime

string · date-time

licensePlate

string

serialNumber

string

vehicleGroupId

string

lastContactProximityDescription

string

terminatedDate

string · date-time

terminalId

string

tractorMake

string

tractorModel

string

tractorYear

integer · int32

tractorStatus

string

mobileCommID

string

odometer

number · double

totalHours

number · double

alternateId

string

currentDriverId

string

lastMessageTimestamp

string · date-time

dieselHours

number · double

electricHours

number · double

licenseState

string

terminalName

string

expirationDate

string

Maintenance records for the tractor

Notes associated with the tractor

GET/v1/partner/{partnercode}/tractors/{id}

curl https://carriercloud.ai/v1/partner/:partnercode/tractors/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "dataGUID": "trk-5f1c2a",
  "tractorNumber": "1412",
  "tractorType1": "Sleeper",
  "tractorStatus": "Available",
  "tractorMake": "Freightliner",
  "tractorModel": "Cascadia",
  "tractorYear": 2023,
  "licensePlate": "PWX8812",
  "licenseState": "OH",
  "serialNumber": "1FUJGLDR5CSBH1234",
  "lastContactDateTime": "2026-10-01T13:42:10.000Z",
  "lastContactCity": "Findlay",
  "lastContactState": "OH",
  "tractorLastContactProximity": "3.2mi S of Findlay, OH",
  "odometer": 412887,
  "maintenance": [
    {
      "name": "Oil change",
      "dueIn": 1800,
      "dueInUnit": "miles",
      "dueDate": "2026-10-20T00:00:00Z"
    }
  ],
  "notes": [
    {
      "dataGUID": "note-1",
      "note": "Assigned to Linehaul",
      "viaNoteType": "Special Instructions"
    }
  ]
}

json

application/json

Tractors - Update Tractor

PUT

https://carriercloud.ai

/v1/partner/{partnercode}/tractors/{id}

Update a tractor by id

Tractors - Update Tractor › path Parameters

partnercode

string · required

id

string · required

The tractor card id

Tractors - Update Tractor › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Tractors - Update Tractor › Request Body optional

Tractor create/update request: only fields read by the inbound truck-card payload mapper (see format-inbound-tractoractor-via / tractor-actor-to-truck-card-payload).

TractorRequestBody

tractorNumber

string

tractorType1

string

tractorType2

string

tractorType3

string

tractorType4

string

tractorStatus

string

tractorMake

string

tractorModel

string

tractorYear

integer · int32

licensePlate

string

serialNumber

string

lastContactDateTime

string · date-time

lastContactCity

string

lastContactState

string

tractorLastContactProximity

string

licenseState

string

mobileCommID

string

odometer

number · double

Maintenance items mapped to VIA; each object uses keys accepted by the inbound maintenance mapper (camelCase; PascalCase alts in code for id/created/name/due*).

Notes for the tractor

Tractors - Update Tractor › Responses

The updated tractor.

id

integer · int32

tractorNumber

string

dataGUID

string

tractorType

string

tractorType1

string

tractorType2

string

tractorType3

string

tractorType4

string

lastContactCity

string

lastContactState

string

lastContactZipCode

string

lastContactLatitude

string

lastContactLongitude

string

lastContactDate

string

lastContactTime

string

tractorLastContactProximity

string

lastContactDateTime

string · date-time

etaCity

string

etaState

string

etaZipCode

string

etaLatitude

string

etaLongitude

string

etaDate

string

etaTime

string

etaDateTime

string · date-time

licensePlate

string

serialNumber

string

vehicleGroupId

string

lastContactProximityDescription

string

terminatedDate

string · date-time

terminalId

string

tractorMake

string

tractorModel

string

tractorYear

integer · int32

tractorStatus

string

mobileCommID

string

odometer

number · double

totalHours

number · double

alternateId

string

currentDriverId

string

lastMessageTimestamp

string · date-time

dieselHours

number · double

electricHours

number · double

licenseState

string

terminalName

string

expirationDate

string

Maintenance records for the tractor

Notes associated with the tractor

PUT/v1/partner/{partnercode}/tractors/{id}

curl https://carriercloud.ai/v1/partner/:partnercode/tractors/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "tractorNumber": "TRK-818",
  "tractorType1": "sleeper",
  "tractorType2": "doubles",
  "tractorMake": "Freightliner",
  "tractorModel": "Cascadia",
  "tractorYear": 2019,
  "tractorStatus": "Available",
  "lastContactDateTime": "2026-04-23T12:00:00Z",
  "lastContactCity": "Dallas",
  "lastContactState": "TX",
  "tractorLastContactProximity": "2mi",
  "licensePlate": "TEX-4L88",
  "serialNumber": "1FUJGHDV0LSBVA00",
  "licenseState": "TX",
  "mobileCommID": "MC-001",
  "odometer": 125430.5,
  "maintenance": [
    {
      "id": "maint-tractor-1",
      "name": "DOT annual inspection",
      "dueIn": 45,
      "dueInUnit": "days",
      "dueDate": "2026-06-15T00:00:00Z",
      "created": "2025-12-01T00:00:00Z"
    }
  ],
  "notes": [
    {
      "note": "Haul This",
      "viaNoteType": "Special Instructions"
    }
  ]
}'

Example Request Body

{
  "tractorNumber": "TRK-818",
  "tractorType1": "sleeper",
  "tractorType2": "doubles",
  "tractorMake": "Freightliner",
  "tractorModel": "Cascadia",
  "tractorYear": 2019,
  "tractorStatus": "Available",
  "lastContactDateTime": "2026-04-23T12:00:00Z",
  "lastContactCity": "Dallas",
  "lastContactState": "TX",
  "tractorLastContactProximity": "2mi",
  "licensePlate": "TEX-4L88",
  "serialNumber": "1FUJGHDV0LSBVA00",
  "licenseState": "TX",
  "mobileCommID": "MC-001",
  "odometer": 125430.5,
  "maintenance": [
    {
      "id": "maint-tractor-1",
      "name": "DOT annual inspection",
      "dueIn": 45,
      "dueInUnit": "days",
      "dueDate": "2026-06-15T00:00:00Z",
      "created": "2025-12-01T00:00:00Z"
    }
  ],
  "notes": [
    {
      "note": "Haul This",
      "viaNoteType": "Special Instructions"
    }
  ]
}

json

Sample request body

application/json

Example Responses

{
  "dataGUID": "trk-5f1c2a",
  "tractorNumber": "1412",
  "tractorType1": "Sleeper",
  "tractorStatus": "Available",
  "tractorMake": "Freightliner",
  "tractorModel": "Cascadia",
  "tractorYear": 2023,
  "licensePlate": "PWX8812",
  "licenseState": "OH",
  "serialNumber": "1FUJGLDR5CSBH1234",
  "lastContactDateTime": "2026-10-01T13:42:10.000Z",
  "lastContactCity": "Findlay",
  "lastContactState": "OH",
  "tractorLastContactProximity": "3.2mi S of Findlay, OH",
  "odometer": 412887,
  "maintenance": [
    {
      "name": "Oil change",
      "dueIn": 1800,
      "dueInUnit": "miles",
      "dueDate": "2026-10-20T00:00:00Z"
    }
  ],
  "notes": [
    {
      "dataGUID": "note-1",
      "note": "Assigned to Linehaul",
      "viaNoteType": "Special Instructions"
    }
  ]
}

json

application/json

Tractors - Delete Tractor

DELETE

https://carriercloud.ai

/v1/partner/{partnercode}/tractors/{id}

Delete a tractor by id

Tractors - Delete Tractor › path Parameters

partnercode

string · required

id

string · required

The tractor card id

Tractors - Delete Tractor › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Tractors - Delete Tractor › Responses

Success

No data returned

Tractors - Get by Tractor Number

GET

https://carriercloud.ai

/v1/partner/{partnercode}/tractors/byNumber/{tractorNumber}

Get tractor by tractor number

Tractors - Get by Tractor Number › path Parameters

partnercode

string · required

tractorNumber

string · required

Tractor number to look up.

Tractors - Get by Tractor Number › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Tractors - Get by Tractor Number › Responses

Tractors matching the number.

TractorActor[]

id

integer · int32

tractorNumber

string

dataGUID

string

tractorType

string

tractorType1

string

tractorType2

string

tractorType3

string

tractorType4

string

lastContactCity

string

lastContactState

string

lastContactZipCode

string

lastContactLatitude

string

lastContactLongitude

string

lastContactDate

string

lastContactTime

string

tractorLastContactProximity

string

lastContactDateTime

string · date-time

etaCity

string

etaState

string

etaZipCode

string

etaLatitude

string

etaLongitude

string

etaDate

string

etaTime

string

etaDateTime

string · date-time

licensePlate

string

serialNumber

string

vehicleGroupId

string

lastContactProximityDescription

string

terminatedDate

string · date-time

terminalId

string

tractorMake

string

tractorModel

string

tractorYear

integer · int32

tractorStatus

string

mobileCommID

string

odometer

number · double

totalHours

number · double

alternateId

string

currentDriverId

string

lastMessageTimestamp

string · date-time

dieselHours

number · double

electricHours

number · double

licenseState

string

terminalName

string

expirationDate

string

Maintenance records for the tractor

Notes associated with the tractor

GET/v1/partner/{partnercode}/tractors/byNumber/{tractorNumber}

curl https://carriercloud.ai/v1/partner/:partnercode/tractors/byNumber/:tractorNumber \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "dataGUID": "trk-5f1c2a",
    "tractorNumber": "1412",
    "tractorType1": "Sleeper",
    "tractorStatus": "Available",
    "tractorMake": "Freightliner",
    "tractorModel": "Cascadia",
    "tractorYear": 2023,
    "licensePlate": "PWX8812",
    "licenseState": "OH",
    "serialNumber": "1FUJGLDR5CSBH1234",
    "lastContactDateTime": "2026-10-01T13:42:10.000Z",
    "lastContactCity": "Findlay",
    "lastContactState": "OH",
    "tractorLastContactProximity": "3.2mi S of Findlay, OH",
    "odometer": 412887,
    "maintenance": [
      {
        "name": "Oil change",
        "dueIn": 1800,
        "dueInUnit": "miles",
        "dueDate": "2026-10-20T00:00:00Z"
      }
    ],
    "notes": [
      {
        "dataGUID": "note-1",
        "note": "Assigned to Linehaul",
        "viaNoteType": "Special Instructions"
      }
    ]
  }
]

json

application/json

Carriers - Get Carriers

GET

https://carriercloud.ai

/v1/partner/{partnercode}/carriers

Get a list of active carriers for a specific partner.

Carriers - Get Carriers › path Parameters

partnercode

string · required

Carriers - Get Carriers › query Parameters

page

integer · int32

Page number to return, starting at 1. Omit for the first page.

Carriers - Get Carriers › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Carriers - Get Carriers › Responses

Carriers for the partner, 100 per page.

object[]

Carrier summary returned by Get Carriers (list). Get Carrier returns the richer camelCase CarrierActor.

ID

string | null

Carrier card identifier; use it as carrierid.

CarrierId

string | null

Carrier code in the partner's system.

CarrierName

string | null

DataGUID

string | null

Scac

string | null

Address1

string | null

Address2

string | null

City

string | null

State

string | null

ZipCode

string | null

CountryCocde

string | null

Country code (historical field name).

Contact

string | null

PrimaryPhone

string | null

SecondaryPhone

string | null

Fax

string | null

Email

string | null

MCNumber

string | null

DotNumber

string | null

Status

string | null

object[]

GET/v1/partner/{partnercode}/carriers

curl https://carriercloud.ai/v1/partner/:partnercode/carriers \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "ID": "car-77c0b1",
    "CarrierId": "ACME01",
    "CarrierName": "Acme Logistics LLC",
    "DataGUID": "car-77c0b1",
    "Scac": "ACML",
    "Address1": "900 Industrial Pkwy",
    "Address2": null,
    "City": "Toledo",
    "State": "OH",
    "ZipCode": "43612",
    "CountryCocde": "USA",
    "Contact": "Dana Reyes",
    "PrimaryPhone": "419-555-0170",
    "SecondaryPhone": null,
    "Fax": null,
    "Email": "[email protected]",
    "MCNumber": "MC-123456",
    "DotNumber": "7654321",
    "Status": "Active",
    "Contacts": [
      {
        "ContactId": "c-1",
        "ContactName": "Dana Reyes",
        "ContactType": "Dispatch",
        "Title": "Dispatch Manager",
        "Phone": "419-555-0170",
        "Email": "[email protected]",
        "CompanyName": "Acme Logistics LLC"
      }
    ]
  }
]

json

application/json

Carriers - Get Carrier

GET

https://carriercloud.ai

/v1/partner/{partnercode}/carriers/{carrierid}

Get a specific carrier's details for a given partner.

Carriers - Get Carrier › path Parameters

partnercode

string · required

carrierid

string · required

Carrier identifier as returned by Get Carriers.

Carriers - Get Carrier › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Carriers - Get Carrier › Responses

The carrier. Keys the platform has no value for are omitted.

Carrier Actor

CarrierActor

id

integer · int32

company

string

integrationId

string

carrierId

string

dataGUID

string

carrierName

string

scac

string

address1

string

address2

string

city

string

state

string

zipCode

string

countryCode

string

primaryPhone

string

secondaryPhone

string

fax

string

fedId

string

mcNumber

string

dotNumber

string

contact

string

lastUpdated

string · date-time

status

string

carrierType1

string

carrierType2

string

carrierType3

string

carrierType4

string

misc1

string

misc2

string

misc3

string

misc4

string