v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Lookup an asset using an external ID

get/v1/assets/lookup_by_external_id

Query parameters

idinteger required

The unique identifier assigned to the external ID.

external_idstring

Specify the external ID of the asset that you want to lookup the information for.

integration_namestring

Specify the name of the integration with which the external_id is associated.

Headers

X-Time-Zonestring

Specify the timezone for formatting the timestamps.

X-Metric-Unitsboolean

Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units

X-User-Idinteger

Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.

Response

200

Example response

{
  "asset": {
    "id": 637,
    "name": "abc",
    "status": "deactivated",
    "type": "dry_box",
    "make": "SOMACOA (STE. MALGACHE DE",
    "model": "AUTOMOBILES TALBOT",
    "year": "2005",
    "external_ids": [
      {
        "external_id": "123",
        "integration_name": "tmw_tmt"
      }
    ]
  }
}