Contact UsCalAmp Status
Documentation
Start typing to search…

API Call Examples

Login

Call Setting

FieldContent

POST

https://connect.calamp.com/connect/services/login

Header

Content-Type: application/x-www-form-urlencoded

Body

x-www-form-urlencoded
username: <user>
password: <pass>
useAuthToken: true

Examples

Smart Search

Call Setting

FieldContent
POSThttps://connect.calamp.com/device-services/devices/smartsearch?include=groups&withIdReport=true&withCredentials=true&withLocation=true&expand=deviceConfiguration&v=2.1&pg=1&pgsize=10&sort=+name
Headercalamp-services-app: <yourAPIkey>
Bodyraw: JSON

Example Search Bodies

ExampleSearch Body

Search for a specific ESN.

{ "search": {"queryString": "4562211953"}}

Request all the devices in an account and its subaccounts.

{ "search": { "queryString": "*", "accountId": 1110, "hierLevel": "All" }}

Request multiple devices.

{ "search": { "queryString": "esn: (4562211953 OR 1110000305 OR 3671000349)" }}

Request all the devices in group 4650.

{ "search": { "queryString": "groupIds: (4650)", "accountId": 1110, "hierLevel": "All" }}

Request all the devices with a name containing "demo."

{ "search": { "queryString": "name: (demo)", "accountId": 1110, "hierLevel": "All" }}

Request all the devices with firmware 8.4a or 8.6c.

{ "search": { "queryString": "extensions.firmwareVersion: (84a OR 86c)", "accountId": 1110, "hierLevel": "All" }}

Examples

Searchable Properties

Property NameTypeComments
accountlong[]
extensions.firmwareVersionstring[]
extensions.networkModestring[]
pegBehaviorIdlong[]
mdnstring[]Searchable without the property name
ipAddressstring[]Searchable without the property name
activationDatedate[]yyyy-MM-dd'T'HH:mm:ss.SSSZ
namestring[]Searchable without the property name
deviceConfigurationIdlong[]
lastModifiedOndatyyyy-MM-dd'T'HH:mm:ss.SSSZ
provisionStatusstring[]
statusresourceStatus[]
serialNumberstring[]Searchable without the property name
extensions.vbusEnableStatusstring[]
extensions.poNumberstring[]
categorydevicecategory[]
createdOndate[]yyyy-MM-dd'T'HH:mm:ss.SSSZ
architecturedevicearchitecture[]
extensions.shippingOrderstring[]
extensions.networkCarrierstring[]
esnstring[]Searchable without the property name
iccidstring[]Searchable without the property name
typeidlong[]
airIdstring[]Searchable without the property name
groupIdslist[]
dmDeviceboolean[]
extensions.signalStrengthstring[]
lastReportedTimedate[]yyyy-MM-dd'T'HH:mm:ss.SSSZ
accountIdlong[]
imeistring[]Searchable without the property name
extensions.configVersionstring[]
idlong[]Searchable without the property name
extensions.skustring[]
externalIdstring[]Searchable without the property name
macAddressstring[]Searchable without the property name
shipDatedate[]yyy-MM-dd'T'HH:mm:ss.SSSZ
typeNamestring[]
meidstring[]Searchable without the property name
typelong[]
extensions.idReportTimestampdate[]yyy-MM-dd'T'HH:mm:ss.SSSZ
extensions.networkCurrentModestring[]
extensions.fileVersionstring[]
extensions.appIdstring[]
minlong[]Searchable without the property name
imsistring[]Searchable without the property name
phoneNumberstring[]Searchable without the property name

Shipping Information

Call Setting

FieldContent
GEThttps://connect.calamp.com/device-services/devices/{esn}/shippinginfo
Headerscalamp-services-app: <yourAPIkey>

Examples

Current Device File

Call Setting

FieldContent
GEThttps://connect.calamp.com/device-services/devices/{esn}/filehistory/current
Headerscalamp-services-app: <yourAPIkey>

Examples

Device File History

Call Setting

FieldContent
GEThttps://connect.calamp.com/device-services/devices/{esn}/filehistory
Headerscalamp-services-app: <yourAPIkey>

Examples

Additional Resources

Updated about 2 months ago

What’s Next
© 2025 CalAmp