How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Carrier Global Core API

The core API from Carrier Global — 13 operation(s) for core.

Carrier Global Core API is one of 7 APIs that Carrier Global publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Core. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 13 operations across 13 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.fleet.lynx.carrier.io/2waycmd, https://api.fleet.lynx.carrier.io.

13 operations 13 paths 51 schemas 8 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.fleet.lynx.carrier.io
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Carrier Global Core API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-lynx-api-key (x-lynx-api-key). By default, every request must be authenticated.

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 8 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Core 13
GET
/v1/check-command-status
Check 2way command status
check-2way-command-status 4 params → 200400401403429500
GET
/v1/get-commands
Get 2way commands
get-2way-commands 3 params → 200400401403429500
POST
/v1/send-commands
Send 2way commands
send-2way-commands body → 200400401403429500
GET
/v1/assets
Get assets list
asset-list-v1 6 params → 200400401403429500
GET
/v1/asset-snapshots
Get asset snapshots list
asset-snapshot-list-v1 6 params → 200400401403429500
GET
/v1/asset-history-items
Get asset history items
asset-history-list-v1 8 params → 200400401403429500
POST
/v1/multi-asset-history
Get multi asset history
multi-asset-history-v1 body → 200400401403429500
GET
/v1/asset-batteries
Get asset batteries list
asset-battery-list-v1 4 params → 200400401403429500
GET
/v1/asset-battery-history
Get asset battery history
asset-battery-history-list-v1 6 params → 200400401403429500
POST
/v1/multi-asset-battery-history
Get multi asset battery history
multi-asset-battery-history-v1 body → 200400401403429500
POST
/v1/scb-ingestor
SCB ingestor
scb-ingestor-v1 body → 200400401403429500
POST
/v1/orbcomm-ingestor
Orbcomm ingestor
orbcomm-ingestor-v1 body → 200400401403429500
GET
/v1/alarm-codes-and-descriptions
Get alarm codes and descriptions
alarm-codes-and-descriptions-v1 1 param → 200400401403429500

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are StatusInfo (28 properties), TemperatureInfo (27 properties), Send2wayCmdRequestBody (15 properties), Asset (15 properties). Each schema is shown below with its type and property counts.

TooManyRequestsError
object
1 property
CommandsStatusList
array
Commands status list
UnexpectedError
object
1 property
SentCommand
object
Information about sent command
3 properties
CommandsStatus
object
Commands status
11 properties
Send2wayResponse
object
Send 2way cmd
1 property
Send2wayCmdRequestBody
object
Send 2way command
15 properties 1 required
ForbiddenRequestError
object
1 property
AuthRequestError
object
1 property
BadRequestError
object
1 property
AvailableCommandsResponse
object
Commands Status
1 property
AssetParamWithTruSerialNumber
object
2 properties 1 required
AssetParamWithLicensePlateNumber
object
2 properties 1 required
AssetList
object
List of Asset objects
3 properties
OrbcommIngestorRequest
object
3 properties
AssetBatteryHistory
object
List of Asset history objects
2 properties
AssetSnapshot
object
Represents telematics data of the device in concrete period of time
7 properties
TemperatureInfo
object
An object containing information about the temperature recordings at the time of the message.
27 properties
MultiAssetHistoryEntry
object
Represents telematics data of the device in the concrete period of time
9 properties
AssetInfo
object
Represents all information about an asset.
14 properties
ConnectedTruckInfo
object
An array containing ConnectedTruckInfo objects, which contain information about signal strength, licensePlate number, macId and truckName.
4 properties
Command
object
Represents basic identifying information about a command.
2 properties
AssetSnapshotList
object
List of Asset snapshot objects
3 properties
ScbIngestorRequest
object
8 properties
MultiAssetHistoryRequest
object
4 properties 3 required
StatusInfo
object
An object containing information about the state of the Transport Refrigeration Unit at the time of the message.
28 properties
AssetBatteryList
object
List of Asset Battery objects
3 properties
MultiAssetHistoryItem
object
2 properties
Alarm
object
An object containing information about any Transport Refrigeration Unit alarms at the time of the message.
3 properties
AssetBattery
object
Represents all information about asset
13 properties 1 required
OrbcommIngestor
object
Orbcomm Ingestor Response
2 properties
CustomFieldsValues
object
User Defined custom fields CustomFieldsValues
4 properties
BatteryEvents
array
An array containing battery event objects.
BatteryEvent
object
Represents historical battery event
11 properties
AssetHistoryList
object
List of Asset history objects
3 properties
ScbIngestor
object
Scb Ingestor Response
2 properties
AssetParamWithId
object
2 properties 1 required
Sensor
object
Information about sensor configuration status
5 properties
PositionInfo
object
An object containing information about the location of the asset at the time of the message.
2 properties
MultiAssetBatteryHistoryItem
object
List of Asset Battery history objects
2 properties
MultiAssetBatteryHistory
array
Multi Asset Battery History
AlarmCodesAndDescriptionsResponse
object
Represents all Alarm codes and descriptions
2 properties 1 required
MultiAssetHistory
array
Multi Asset History
AssetHistoryEntry
object
Represents telematics data of the device in the concrete period of time
9 properties
CommandInfo
array
An array containing Command objects.
MultiAssetBatteryHistoryRequest
object
4 properties 3 required
AlarmInfo
array
An array containing AlarmInfo objects, which contains information about any Transport Refrigeration Unit alarms at the time of the message.
AssetBatteryInfo
object
Represents basic info about Asset
3 properties
Asset
object
Represents all information about an asset.
15 properties 1 required
AssetParamWithName
object
2 properties 1 required
AlarmCodesAndDescriptions
object
List of Alarm codes and descriptions
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

carrier-global-core-api-openapi.yml Raw ↑

Other APIs Carrier Global publishes across the network.

Carrier Lynx Dev Portal GraphQL
Carrier i-Vu Building Automation
Carrier Comfort Network
Carrier Abound
Carrier SmartHome App
Carrier Global Core2 API
Where this information came from

This is an independent, third-party profile of Carrier Global Core API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.