GET api/v4/service?userID={userID}&token={token}&imei={imei}

Get a service by imei

Request Information

URI Parameters

Name	Description	Type	Additional information
userID	The userid being used for authentication	unsigned integer	Required
token	The token being used for authentication	string	Required
imei	The imei being queried	string	Required

Body Parameters

None.

Response Information

Resource Description

A service

Service

Name	Description	Type	Additional information
ID	The unique id of a service	unsigned integer	None.
UserID	The user id who owns the service	unsigned integer	None.
SageReference	Billing information	integer	None.
Created	When the service was created	date	None.
DriverName		string	None.
ContractEndDate	The contact end date	date	None.
ContractStartDate	The contact start date	date	None.
RenewalDue	Date when the renewal is due	date	None.
RenewalCost	The renewal cost	decimal number	None.
MonthlyContract	If the service is a monthly contact	boolean	None.
DeviceID	The id of the device attached to a service	unsigned integer	None.
Device	The device information attached to the service	Device	None.
VehReg	The registration of the service	string	None.
VehIcon1	The icon of the service displayed on the websites	string	None.
VehIcon2	The second icon of the service displayed on the websites	string	None.
V5Icon		string	None.
Vin		string	None.
StatusUpdateDate		date	None.
Status		integer	None.
V5IconColor		string	None.
VehBody	The vehicle body	string	None.
VehChasis	The vehicle chassis	string	None.
VehYear	The year the vehicle was made	string	None.
VehSeats	The amount of seats in the vehicle	integer	None.
VehAveMpg	The vehicle MPG	decimal number	None.
VehCostPerMile	The vehicle cost per mile	decimal number	None.
VehCuttingWidth	Cutting width if applicable	decimal number	None.
RoutingPermission	If the service is allowed access to routing	boolean	None.
FriendlyName		string	None.
VehOtherReg		string	None.
SocialDriverService	If the service is for social driver	boolean	None.
VehWeekdayAuthStart	Authorised times for a service	string	None.
VehWeekdayAuthEnd	Authorised times for a service	string	None.
VehWeekendAuthStart	Authorised times for a service	string	None.
VehWeekendAuthEnd	Authorised times for a service	string	None.
VehSundayAuthStart	Authorised times for a service	string	None.
VehSundayAuthEnd	Authorised times for a service	string	None.
LatestTelemetry	The latest telemetry for the service		None.

Response Formats

application/json, text/json

Sample:

{
  "veh_wd_auth_start": "00:00",
  "veh_wd_auth_end": "23:59",
  "veh_we_auth_start": "00:00",
  "veh_we_auth_end": "23:59",
  "veh_sun_auth_start": "00:00",
  "veh_sun_auth_end": "23:59",
  "<ID>k__BackingField": 1,
  "<UserID>k__BackingField": 2,
  "<SageReference>k__BackingField": 3,
  "<Created>k__BackingField": "2026-08-04T21:37:43.7123083+00:00",
  "<DriverName>k__BackingField": "sample string 5",
  "<ContractEndDate>k__BackingField": "2026-08-04T21:37:43.7123083+00:00",
  "<ContractStartDate>k__BackingField": "2026-08-04T21:37:43.7123083+00:00",
  "<RenewalDue>k__BackingField": "2026-08-04T21:37:43.7123083+00:00",
  "<RenewalCost>k__BackingField": 7.1,
  "<MonthlyContract>k__BackingField": true,
  "<DeviceID>k__BackingField": 9,
  "<Device>k__BackingField": {
    "ID": 1,
    "UserID": 2,
    "IMEI": "sample string 3",
    "SerialNo": "sample string 4",
    "DevType": {
      "ID": 1,
      "Name": "sample string 2",
      "GeofenceEnabled": true,
      "ImmobiliserEnabled": true
    },
    "Sim": {
      "ID": 1,
      "Network": {
        "ID": 1,
        "Name": "sample string 2",
        "APN": "sample string 3",
        "APNUsername": "sample string 4",
        "APNPassword": "sample string 5",
        "Notes": "sample string 6",
        "Log": "sample string 7"
      },
      "SIMNo": "sample string 2",
      "MobileNo": "3",
      "isMatrixSIM": true,
      "Created": "2026-08-04T21:37:43.7123083+00:00",
      "LastUpdated": "2026-08-04T21:37:43.7123083+00:00",
      "MobileSIMNumberConcatenated": "3 - sample string 2",
      "Barred": true,
      "Terminated": true
    },
    "Firmware": "sample string 5",
    "FleetKey": "sample string 6",
    "I0_Type": 7,
    "I1_Type": 8,
    "I2_Type": 9,
    "I3_Type": 10,
    "I0_Dir": true,
    "I1_Dir": true,
    "I2_Dir": true,
    "I3_Dir": true,
    "I0_Display": true,
    "I1_Display": true,
    "I2_Display": true,
    "I3_Display": true,
    "Output0_Type": 19,
    "Output1_Type": 20,
    "Output2_Type": 21,
    "Output0_Display": true,
    "Output1_Display": true,
    "Output2_Display": true,
    "HeartbeatType": 25,
    "OdometerOffset": 26,
    "HoursOffset": 27,
    "Notes": "sample string 28",
    "Log": "sample string 29",
    "DeviceEcode": "sample string 30",
    "Input0DistanceOffset": 31,
    "Input1DistanceOffset": 32,
    "Input2DistanceOffset": 33,
    "Input3DistanceOffset": 34,
    "Input0DurationOffset": 35,
    "Input1DurationOffset": 36,
    "Input2DurationOffset": 37,
    "Input3DurationOffset": 38,
    "I4_Type": 39,
    "I4_Dir": true,
    "I4_Display": true,
    "I5_Type": 42,
    "I5_Dir": true,
    "I5_Display": true,
    "Input4DistanceOffset": 45,
    "Input4DurationOffset": 46,
    "Input5DistanceOffset": 47,
    "Input5DurationOffset": 48,
    "ContractStartDateForLog": "sample string 49",
    "ContractEndDateForLog": "sample string 50"
  },
  "<VehReg>k__BackingField": "sample string 10",
  "<VehIcon1>k__BackingField": "sample string 11",
  "<VehIcon2>k__BackingField": "sample string 12",
  "<V5Icon>k__BackingField": "sample string 13",
  "<Vin>k__BackingField": "sample string 14",
  "<StatusUpdateDate>k__BackingField": "2026-08-04T21:37:43.7123083+00:00",
  "<Status>k__BackingField": 16,
  "<V5IconColor>k__BackingField": "sample string 17",
  "<VehBody>k__BackingField": "sample string 18",
  "<VehChasis>k__BackingField": "sample string 19",
  "<VehYear>k__BackingField": "sample string 20",
  "<VehSeats>k__BackingField": 21,
  "<VehAveMpg>k__BackingField": 22.1,
  "<VehCostPerMile>k__BackingField": 23.1,
  "<VehCuttingWidth>k__BackingField": 24.1,
  "<RoutingPermission>k__BackingField": true,
  "<FriendlyName>k__BackingField": "sample string 26",
  "<VehOtherReg>k__BackingField": "sample string 27",
  "<SocialDriverService>k__BackingField": true,
  "<LatestTelemetry>k__BackingField": {
    "TelemetryOutput4": true,
    "AccelerationLevel": 2.1,
    "AccelerationDuration": 3,
    "DTCs": [
      "sample string 1",
      "sample string 2"
    ],
    "VIN": "sample string 4",
    "FirmwareVersion": "sample string 5",
    "CrashData": [
      {
        "<street>k__BackingField": "sample string 1",
        "<town>k__BackingField": "sample string 2",
        "<country>k__BackingField": "sample string 3",
        "<postcode>k__BackingField": "sample string 4",
        "<speed_limit>k__BackingField": 5,
        "<fix>k__BackingField": 6,
        "<lat>k__BackingField": 7.1,
        "<lon>k__BackingField": 8.1,
        "<heading>k__BackingField": 9.1,
        "<speed>k__BackingField": 10.1,
        "<micADC>k__BackingField": 11,
        "<x>k__BackingField": 12.1,
        "<y>k__BackingField": 13.1,
        "<z>k__BackingField": 14.1,
        "<g_force>k__BackingField": 15.1,
        "<timestamp>k__BackingField": 16,
        "<sample_number>k__BackingField": 17
      },
      {
        "<street>k__BackingField": "sample string 1",
        "<town>k__BackingField": "sample string 2",
        "<country>k__BackingField": "sample string 3",
        "<postcode>k__BackingField": "sample string 4",
        "<speed_limit>k__BackingField": 5,
        "<fix>k__BackingField": 6,
        "<lat>k__BackingField": 7.1,
        "<lon>k__BackingField": 8.1,
        "<heading>k__BackingField": 9.1,
        "<speed>k__BackingField": 10.1,
        "<micADC>k__BackingField": 11,
        "<x>k__BackingField": 12.1,
        "<y>k__BackingField": 13.1,
        "<z>k__BackingField": 14.1,
        "<g_force>k__BackingField": 15.1,
        "<timestamp>k__BackingField": 16,
        "<sample_number>k__BackingField": 17
      }
    ],
    "CrashAccelerometerData": [
      {
        "<micADC>k__BackingField": 1,
        "<x>k__BackingField": 2.1,
        "<y>k__BackingField": 3.1,
        "<z>k__BackingField": 4.1,
        "<g_force>k__BackingField": 5.1,
        "<timestamp>k__BackingField": 6,
        "<sample_number>k__BackingField": 7
      },
      {
        "<micADC>k__BackingField": 1,
        "<x>k__BackingField": 2.1,
        "<y>k__BackingField": 3.1,
        "<z>k__BackingField": 4.1,
        "<g_force>k__BackingField": 5.1,
        "<timestamp>k__BackingField": 6,
        "<sample_number>k__BackingField": 7
      }
    ],
    "CrashGPSData": [
      {
        "<street>k__BackingField": "sample string 1",
        "<town>k__BackingField": "sample string 2",
        "<country>k__BackingField": "sample string 3",
        "<postcode>k__BackingField": "sample string 4",
        "<speed_limit>k__BackingField": 5,
        "<fix>k__BackingField": 6,
        "<lat>k__BackingField": 7.1,
        "<lon>k__BackingField": 8.1,
        "<heading>k__BackingField": 9.1,
        "<speed>k__BackingField": 10.1,
        "<timestamp>k__BackingField": 11,
        "<sample_number>k__BackingField": 12
      },
      {
        "<street>k__BackingField": "sample string 1",
        "<town>k__BackingField": "sample string 2",
        "<country>k__BackingField": "sample string 3",
        "<postcode>k__BackingField": "sample string 4",
        "<speed_limit>k__BackingField": 5,
        "<fix>k__BackingField": 6,
        "<lat>k__BackingField": 7.1,
        "<lon>k__BackingField": 8.1,
        "<heading>k__BackingField": 9.1,
        "<speed>k__BackingField": 10.1,
        "<timestamp>k__BackingField": 11,
        "<sample_number>k__BackingField": 12
      }
    ],
    "CanData": [
      {
        "ServiceId": 1,
        "Timestamp": "2026-08-04T21:37:43.7123083+00:00",
        "Voltage": 3.1,
        "MileageCategory": 4,
        "TotalMileage": 5,
        "TotalFuelConsumption": 6,
        "EngineSpeed": 7,
        "VehicleSpeed": 8.1,
        "AirFlow": 9.1,
        "InletTemperature": 10.1,
        "IntakeManifoldPressure": 11,
        "MILStatus": true,
        "NumberOfDTCPressent": 13,
        "CoolantTemperature": 14.1,
        "VehicleAmbientTemperature": 15.1,
        "FuelPressure": 16,
        "AtmosphericPressure": 17,
        "ValvePositionSensor": 18.1,
        "AcceleratorPedalPosition": 19.1,
        "EngineRunningTime": 20,
        "FaultyMileage": 21,
        "RemainingOil": 22.1,
        "EngineLoad": 23.1,
        "LongTermFuelCorrection": 24.1,
        "IgnitionAdvanceAngle": 25.1,
        "TotalBusMileage": 26,
        "TotalVehicleRunningTime": 27
      },
      {
        "ServiceId": 1,
        "Timestamp": "2026-08-04T21:37:43.7123083+00:00",
        "Voltage": 3.1,
        "MileageCategory": 4,
        "TotalMileage": 5,
        "TotalFuelConsumption": 6,
        "EngineSpeed": 7,
        "VehicleSpeed": 8.1,
        "AirFlow": 9.1,
        "InletTemperature": 10.1,
        "IntakeManifoldPressure": 11,
        "MILStatus": true,
        "NumberOfDTCPressent": 13,
        "CoolantTemperature": 14.1,
        "VehicleAmbientTemperature": 15.1,
        "FuelPressure": 16,
        "AtmosphericPressure": 17,
        "ValvePositionSensor": 18.1,
        "AcceleratorPedalPosition": 19.1,
        "EngineRunningTime": 20,
        "FaultyMileage": 21,
        "RemainingOil": 22.1,
        "EngineLoad": 23.1,
        "LongTermFuelCorrection": 24.1,
        "IgnitionAdvanceAngle": 25.1,
        "TotalBusMileage": 26,
        "TotalVehicleRunningTime": 27
      }
    ],
    "updated": true,
    "TemperatureSamples": [
      {
        "TemperatureSensorId": "sample string 1",
        "Temperature": 2.1,
        "Humidity": 3.1,
        "BatteryPercentage": 4
      },
      {
        "TemperatureSensorId": "sample string 1",
        "Temperature": 2.1,
        "Humidity": 3.1,
        "BatteryPercentage": 4
      }
    ],
    "geoState": "sample string 7",
    "SegmentID": 8,
    "RoadType": 0,
    "DriverWorkingState": 9,
    "DriverRealTimeState": 10,
    "PDOP": 11.1,
    "HDOP": 12.1,
    "TowState": true,
    "PowerLossState": true,
    "LocalGPSTime": "2026-08-04T21:37:43.7123083+00:00",
    "POIName": "sample string 16",
    "BadaiTechAlarmId": 17,
    "TeltonikaBLETags": [
      {
        "Temperature": 1.1,
        "BatteryVoltage": 2.1,
        "RSSI": 64,
        "AssetId": "sample string 4"
      },
      {
        "Temperature": 1.1,
        "BatteryVoltage": 2.1,
        "RSSI": 64,
        "AssetId": "sample string 4"
      }
    ],
    "TeltonikaTachographs": [
      {
        "DriverId": "sample string 1",
        "DriverWorkingState": 2,
        "DriverRealTimeState": 3
      },
      {
        "DriverId": "sample string 1",
        "DriverWorkingState": 2,
        "DriverRealTimeState": 3
      }
    ],
    "TeltonikaDataElements": {
      "1": {},
      "3": {}
    },
    "UbisealDeviceStatus": 1,
    "UbisealRfid": "sample string 18",
    "DeviceType": 19,
    "SensorBatteryPercentage": 20,
    "KinesisProcessTime": "2026-08-04T21:37:43.7123083+00:00",
    "ID": 22,
    "sysServiceId": 23,
    "sysMsgType": 24,
    "sysProcessedTime": "2026-08-04T21:37:43.7123083+00:00",
    "sysProcessedBy": "sample string 26",
    "sysAssetId": "sample string 27",
    "sysAssetIdNumerical": 28,
    "sysGeofenceId": 29,
    "sysDeviceId": 30,
    "gpsTime": "2026-08-04T21:37:43.7123083+00:00",
    "gpsPosition": {
      "_latitude": {
        "_element": 120.32113697747289
      },
      "_longitude": {
        "_element": 120.32113697747289
      },
      "_foLat": {
        "_element": 49.0
      },
      "_foLong": {
        "_element": -2.0
      },
      "_af0": 6375585.7452000007,
      "_bf0": 6354209.61327432
    },
    "gpsOrientation": {
      "Heading": 1.1
    },
    "gpsSpeed": {
      "MPS": 9816.998,
      "KPH": 35341.1953,
      "MPH": 21960.002,
      "Metres": 9816.998,
      "Kilometres": 9.81699848,
      "Miles": 6.10000038
    },
    "gpsFix": 32,
    "gpsPeriodMaxSpeed": {
      "MPS": 9816.998,
      "KPH": 35341.1953,
      "MPH": 21960.002,
      "Metres": 9816.998,
      "Kilometres": 9.81699848,
      "Miles": 6.10000038
    },
    "gpsPeriodInvalidSamples": 33,
    "LocationCheckDone": true,
    "geoStreet": "sample string 35",
    "geoTown": "sample string 36",
    "geoCity2": "sample string 37",
    "geoCounty": "sample string 38",
    "geoCountry": "sample string 39",
    "geoPostcode": "sample string 40",
    "geoSpeedLimit": 41,
    "journeyDistance": {
      "Metres": 4988.96631,
      "Kilometres": 4.98896646,
      "Miles": 3.10000014
    },
    "journeyDuration": "00:00:00.1234567",
    "journeyIdleTime": "00:00:00.1234567",
    "journeyStatus": true,
    "journeyLegCode": 45,
    "journeyDeviceJourneyId": 46,
    "despatchMovementId": 47,
    "despatchVehicleId": 48,
    "telemetryState": 49,
    "telemetryIgnition": true,
    "telemetryAlarm": true,
    "telemetryPanic": true,
    "telemetryShield": true,
    "telemetryTheftattempt": true,
    "telemetryTamper": true,
    "telemetryExternalAlarm": true,
    "telemetryJourney": true,
    "telemetryJourneyStatus": true,
    "telemetryIdle": true,
    "telemetryExtendedIdle": true,
    "telemetryHours": 61,
    "telemetryInput0": true,
    "telemetryInput1": true,
    "telemetryInput2": true,
    "telemetryInput3": true,
    "telemetryInput4": true,
    "telemetryInput5": true,
    "telemetryInput6": true,
    "telemetryInput7": true,
    "telemetryInput8": true,
    "telemetryInput9": true,
    "telemetryOutput0": true,
    "telemetryOutput1": true,
    "telemetryOutput2": true,
    "telemetryOutput3": true,
    "telemetryAnalogueInput0State": true,
    "telemetryAnalogueInput1State": true,
    "telemetryAnalogueInput2State": true,
    "telemetryAnalogueInput3State": true,
    "analogueInput0Voltage": 80.1,
    "analogueInput1Voltage": 81.1,
    "analogueInput2Voltage": 82.1,
    "analogueInput3Voltage": 83.1,
    "telemetryTemperature": 84.1,
    "telemetryVoltage": 85.1,
    "telemetryOdometer": 86,
    "harshAccelCount1": 87,
    "harshAccelCount2": 88,
    "harshAccelCount3": 89,
    "harshAccelCount4": 90,
    "harshAccelCount5": 91,
    "harshBrakeCount1": 92,
    "harshBrakeCount2": 93,
    "harshBrakeCount3": 94,
    "harshBrakeCount4": 95,
    "harshBrakeCount5": 96,
    "IOBitmask": 1,
    "BatteryCharging": true,
    "XAcceleration": 98,
    "YAcceleration": 99,
    "ZAcceleration": 100,
    "Altitude": 101,
    "BatteryChargePercentage": 102.1,
    "BatteryChargeTime": 103,
    "BatteryRange": 104,
    "TeltonikaTotalOdometer": 105,
    "Humidity": 106.1,
    "NetworkCountryCode": 107,
    "NetworkOperator": 108,
    "NetworkMode": 109,
    "NetworkConnected": true,
    "ForcePassthroughMessageCheck": true,
    "TeltonikaFrontCameraState": 64,
    "TeltonikaRearCameraState": 64,
    "ModemSignalStrength": 114,
    "PassthroughData": "sample string 115",
    "AlcoLockValue": "sample string 116",
    "lowMediumHighScore": "sample string 117"
  },
  "<SysRenewalPeriodMonths>k__BackingField": 35,
  "<Sys_account_number>k__BackingField": "sample string 36",
  "<Sys_min_number_renewals>k__BackingField": 37,
  "<Log>k__BackingField": "sample string 38",
  "<Activation_Inverted>k__BackingField": true,
  "<DocumentReference>k__BackingField": "sample string 40",
  "<DocumentReferenceExpiryDate>k__BackingField": "2026-08-04T21:37:43.7123083+00:00",
  "<Configuration>k__BackingField": {
    "id": 1,
    "sys_service_id": 2,
    "serviceMode": true,
    "movement": true,
    "overwatch": true,
    "update_Time": "2026-08-04T21:37:43.7123083+00:00",
    "AlertSchedule": {
      "MondayOn": "sample string 1",
      "MondayOff": "sample string 2",
      "TuesdayOn": "sample string 3",
      "TuesdayOff": "sample string 4",
      "WednesdayOn": "sample string 5",
      "WednesdayOff": "sample string 6",
      "ThursdayOn": "sample string 7",
      "ThursdayOff": "sample string 8",
      "FridayOn": "sample string 9",
      "FridayOff": "sample string 10",
      "SaturdayOn": "sample string 11",
      "SaturdayOff": "sample string 12",
      "SundayOn": "sample string 13",
      "SundayOff": "sample string 14"
    },
    "AllowPositionCheck": true
  },
  "<MaxVoltage>k__BackingField": 42.1,
  "<MinVoltage>k__BackingField": 43.1,
  "<ECode>k__BackingField": "sample string 44",
  "<CommCode>k__BackingField": "sample string 45",
  "<Description>k__BackingField": "sample string 46",
  "<LowCategory>k__BackingField": "sample string 47",
  "<MidCategory>k__BackingField": "sample string 48",
  "<HighCategory>k__BackingField": "sample string 49",
  "<ContractCode>k__BackingField": "sample string 50",
  "<EstimatedHireEndDate>k__BackingField": "2026-08-04T21:37:43.7123083+00:00",
  "<ActualHireEndDate>k__BackingField": "2026-08-04T21:37:43.7123083+00:00",
  "<LolerCertificateName>k__BackingField": "sample string 53",
  "<LolerCertificateS3Key>k__BackingField": "sample string 54",
  "<TRCertificateName>k__BackingField": "sample string 55",
  "<TRCertificateS3Key>k__BackingField": "sample string 56",
  "<CompanyName>k__BackingField": "sample string 57",
  "<Active>k__BackingField": true,
  "<ExternalContactNumber>k__BackingField": "sample string 59",
  "<ExternalCustomerName>k__BackingField": "sample string 60",
  "<VehNotes>k__BackingField": "sample string 61",
  "<ServiceType>k__BackingField": 0,
  "<DecelerationThreshold>k__BackingField": 62,
  "<AccelerationThreshold>k__BackingField": 63,
  "<Region>k__BackingField": "sample string 64",
  "<DefaultJourneyType>k__BackingField": 0,
  "<Sop>k__BackingField": 65,
  "<BillingStartDate>k__BackingField": "2026-08-04T21:37:43.7123083+00:00",
  "<BillingEndDate>k__BackingField": "2026-08-04T21:37:43.7123083+00:00",
  "<SageSupplierReference>k__BackingField": "sample string 68",
  "<CommisionRate>k__BackingField": 69.1,
  "<SalesPersonReference>k__BackingField": 70,
  "<ImportedSysUserId>k__BackingField": 71,
  "<SysRateId>k__BackingField": 72,
  "<SysTariffId>k__BackingField": 73,
  "<InstallDate>k__BackingField": "2026-08-04T21:37:43.7123083+00:00",
  "<BilledCountryCode>k__BackingField": "sample string 75",
  "<InstallerReference>k__BackingField": 76,
  "<SysStandingRateId>k__BackingField": 77,
  "<LastFeeAmount>k__BackingField": 78.0,
  "<FeeLastCalculatedDate>k__BackingField": "2026-08-04T21:37:43.7123083+00:00",
  "<UrbanMPG>k__BackingField": 80.0,
  "<ExtraUrbanMPG>k__BackingField": 81.0,
  "<CombinedMPG>k__BackingField": 82.0,
  "<UsDot>k__BackingField": "sample string 83",
  "<NoSpaceReg>k__BackingField": "sample string 84",
  "<AdminLog>k__BackingField": "sample string 85"
}