Provides device management functions.
Search for devices.
Get the device with an IMEI of "990000862471854".
GET /SRP00000/api/v1/devices?query=imei=990000862471854
{
"devices": [ {
"links" : [ {
"rel" : "userDevice",
"href" : "https://server01:18084/SRP00000/api/v1/users/6dd3a8e2-3f24-48c6-961a-949794f4b554/userDevices/2d2d3a7f-076d-46f9-8c25-56cb8eba2800"
}, {
"rel" : "sharedDeviceGroup",
"href" : "https://server01:18084/SRP00000/api/v1/sharedDeviceGroups/361287bf-d2b9-4a3a-80db-0da4c80de5f2"
} ],
"guid": "4659aa7f-0a7d-9f69-258c-2800ebaa2800",
"activationDate": "2017-01-16T14:47:03.662Z",
"activeSyncId": "K6CKULJTID3SDEAIV0ELHBBTTO",
"batteryLevel": 95.0,
"compromised": false,
"externalStorageFree": 12021.0,
"externalStorageSize": 16386.0,
"hardwareModel": "Desire",
"hardwareName": "bravo",
"hardwareVendorCompanyName": "HTC Corporation",
"homeCarrier": "Rogers",
"currentCarrier": "Rogers",
"networkRoaming": false,
"acquireLogs": "SUPPORTED",
"iccid": "8938 0012 1050 8728 331",
"internalStorageFree": 2112.0,
"internalStorageSize": 32768.0,
"imei": "990000862471854",
"os": "Android 5.0",
"osFamilyName": "android",
"osVersion": "5.0",
"ownership": "PERSONAL",
"phoneNumber": "4045551234",
"serialNumber": "c08088415436112",
"udid": "d88496fdf7115ac9f3ab69966cbaf91d960b95036fa68f66489c8ad78f136b5c",
"wifiMacAddress": "62:9a:7e:bc:fe:01",
"clientId": "com.rim.mobilefusion.client",
"clientVersion": "12.34.0.154893",
"ramTotal": 4096,
"ramFree": 3556.0
} ]
}
Get the first 50 devices sorted by OS in descending order. If 50 devices are returned, there may be more matches that
weren't returned. You can get the next "page" of devices by sending the same request but also specifying
offset=50. If 50 devices are returned again, you can get the third "page" of devices by modifying the request
again and specifying offset=100, and so on.
GET /SRP00000/api/v1/devices?max=50&sortBy=os%20DESC
{
"devices": [ {
"links" : [ {
"rel" : "userDevice",
"href" : "https://server01:18084/SRP00000/api/v1/users/6dd3a8e2-3f24-48c6-961a-949794f4b554/userDevices/59dc743d-f325-4a6c-97ac-44dcb9ef8a0e"
} ],
"guid": "8002ebaa-c258-96f9-d7a0a-0082aa7f4659",
"activationDate": "2017-01-16T14:47:03.662Z",
"activeSyncId": "Q633AGG6QP3FJF6QBNAA81UHB0",
"batteryLevel": 64.0,
"compromised": false,
"externalStorageFree": 12021.0,
"externalStorageSize": 16386.0,
"hardwareModel": "Desire",
"hardwareName": "bravo",
"hardwareVendorCompanyName": "HTC Corporation",
"homeCarrier": "Rogers",
"currentCarrier": "Vodafone",
"networkRoaming": true,
"acquireLogs": "SUPPORTED",
"iccid": "8938 0012 1050 8728 331",
"internalStorageFree": 2112.0,
"internalStorageSize": 32768.0,
"imei": "351756051523999",
"meid": "01234567890123456",
"ownership": "CORPORATE",
"os": "Android 6.0",
"osFamilyName": "android",
"osVersion": "6.0",
"phoneNumber": "2125557890",
"securityPatchLevel": "6.0.1.1345",
"serialNumber": "c03618841215084",
"udid": "82f2aaa813c5a4bc2748b078ca844bdbd6a8fb8eaaa173a389467646cf04d00c",
"wifiMacAddress": "b4:52:7e:62:a5:9a",
"clientId": "com.rim.mobilefusion.client",
"clientVersion": "12.34.0.154893"
}, {
"links" : [ {
"rel" : "userDevice",
"href" : "https://server01:18084/SRP00000/api/v1/users/6dd3a8e2-3f24-48c6-961a-949794f4b554/userDevices/2d2d3a7f-076d-46f9-8c25-56cb8eba2800"
} ],
"guid": "4659aa7f-0a7d-9f69-258c-2800ebaa2800",
"activationDate": "2017-01-16T14:47:03.662Z",
"activeSyncId": "K6CKULJTID3SDEAIV0ELHBBTTO",
"batteryLevel": 95.0,
"compromised": false,
"externalStorageFree": 12021.0,
"externalStorageSize": 16386.0,
"hardwareModel": "Desire",
"hardwareName": "bravo",
"hardwareVendorCompanyName": "HTC Corporation",
"homeCarrier": "Rogers",
"iccid": "8938 0012 1050 8728 331",
"internalStorageFree": 2112.0,
"internalStorageSize": 32768.0,
"imei": "990000862471854",
"acquireLogs": "SUPPORTED";
"os": "Android 5.0",
"osFamilyName": "android",
"osVersion": "5.0",
"ownership": "PERSONAL",
"phoneNumber": "4045551234",
"serialNumber": "c08088415436112",
"udid": "d88496fdf7115ac9f3ab69966cbaf91d960b95036fa68f66489c8ad78f136b5c",
"wifiMacAddress": "62:9a:7e:bc:fe:01",
"clientId": "com.rim.mobilefusion.client",
"clientVersion": "12.34.0.154893",
"ramTotal": 6144,
"ramFree": 1028.4
} ]
}
Get the device with a BlackBerry Dynamics container GUID of "71D6F61F-6996-4360-8D74-36A9D1637A23".
GET /SRP00000/api/v1/devices?query=dynamicsContainerId=71D6F61F-6996-4360-8D74-36A9D1637A23
{
"devices": [ {
"links" : [ {
"rel" : "userDevice",
"href" : "https://server01:18084/SRP00000/api/v1/users/6dd3a8e2-3f24-48c6-961a-949794f4b554/userDevices/2d2d3a7f-076d-46f9-8c25-56cb8eba2800"
},{
"rel": "userDeviceApplication",
"href": "https://server01:18084/SRP00000/api/v1/users/6dd3a8e2-3f24-48c6-961a-949794f4b554/userDevices/2d2d3a7f-076d-46f9-8c25-56cb8eba2800/applications/b6df080a-98b8-41a7-8498-49644c793d70"
}],
"guid": "4659aa7f-0a7d-9f69-258c-2800ebaa2800",
"activationDate": "2017-01-16T14:47:03.662Z",
"activeSyncId": "K6CKULJTID3SDEAIV0ELHBBTTO",
"batteryLevel": 95.0,
"compromised": false,
"externalStorageFree": 12021.0,
"externalStorageSize": 16386.0,
"hardwareModel": "Desire",
"hardwareName": "bravo",
"hardwareVendorCompanyName": "HTC Corporation",
"homeCarrier": "Rogers",
"networkRoaming": false,
"acquireLogs": "SUPPORTED",
"iccid": "8938 0012 1050 8728 331",
"internalStorageFree": 2112.0,
"internalStorageSize": 32768.0,
"imei": "990000862471854",
"os": "Android 5.0",
"osFamilyName": "android",
"osVersion": "5.0",
"ownership": "PERSONAL",
"phoneNumber": "4045551234",
"serialNumber": "c08088415436112",
"udid": "d88496fdf7115ac9f3ab69966cbaf91d960b95036fa68f66489c8ad78f136b5c",
"wifiMacAddress": "62:9a:7e:bc:fe:01",
"clientId": "com.rim.mobilefusion.client",
"clientVersion": "12.34.0.154893",
"ramTotal": 6144,
"ramFree": 1028.4
} ]
}
Get all the device for the operating system family "WP" and the hardware model "909".
GET /SRP00000/api/v1/devices?query=os=WP,hardwareModel=909
{
"devices": [ {
"links" : [ {
"rel" : "userDevice",
"href" : "https://server01:18084/SRP00000/api/v1/users/6dd3a8e2-3f24-48c6-961a-949794f4b554/userDevices/59dc743d-f325-4a6c-97ac-44dcb9ef8a0e"
} ],
"guid": "2380be82f-7d0a-8e27-d371-4104ebca2b13",
"activationDate": "2023-01-12T19:24:34.487Z",
"batteryLevel": 93,
"hardwareModel": "909",
"hardwareName": "RM-875",
"hardwareVendorCompanyName": "Nokia Corporation",
"currentCarrier": "Bell",
"internalStorageFree": 10766110700,
"internalStorageSize": 65536,
"imei": "13068241772981",
"acquireLogs": "DISABLED",
"os": "WP 8.0.10501",
"osFamilyName": "WP",
"osVersion": "8.0.10501",
"ownership": "UNKNOWN",
"udid": "9c8496fdf729aac9f31869966cbaf91d962295036fb97f66390c843017e368d1",
"clientVersion": "1.1.1.3",
"ramTotal": 2000
} ]
}
Get all the device for the activation type MDM_CONTROLS.
GET /SRP00000/api/v1/devices?query=activationType=MDM_CONTROLS
{
"devices": [ {
"links" : [ {
"rel" : "userDevice",
"href" : "https://server01:18084/SRP00000/api/v1/users/6dd3a8e2-3f24-48c6-961a-949794f4b554/userDevices/59dc743d-f325-4a6c-97ac-44dcb9ef8a0e"
} ],
"guid": "63d34b72-7f24-28c6-06d1-f88892f4b521",
"activationDate": "2023-01-12T19:24:35.910Z",
"hardwareModel": "MacBook Pro (Early 2015)",
"hardwareName": "MacBookPro12,1",
"hardwareVendorCompanyName": "Apple Inc",
"internalStorageFree": 10766110700,
"internalStorageSize": 0,
"imei": "12857250964140",
"os": "OSX 10.12.3",
"osFamilyName": "OSX",
"osVersion": "10.12.3",
"ownership": "CORPORATE",
"udid": "3c8426fdf7b9a489f51869966cbaf91d962290036fb97f66390cb43017e36828",
"supervised": true
}, {
"links": [ {
"rel": "userDevice",
"href": "https://server01:18084/SRP00000/api/v1/users/180ca2cb-a931-8f40-3972-e964d8559c4/userDevices/28d08d63-43bf-510c-783d-52a2b829bea7"
} ],
"guid": "53d28b61-7f94-32d6-18d1-971892fa6518",
"activationDate": "2023-01-12T19:24:35.786Z",
"batteryLevel": 95,
"compromised": false,
"externalStorageSize": 4596.94,
"hardwareModel": "Galaxy S",
"hardwareName": "GT-I9000",
"hardwareVendorCompanyName": "Samsung Electronics",
"currentCarrier": "",
"internalStorageFree": 10766110700,
"internalStorageSize": 16384,
"imei": "6144507978721",
"os": "Android 5.0",
"acquiredLogs": "NOT_SUPPORTED"
"osFamilyName": "android",
"osVersion": "5.0",
"ownership": "CORPORATE",
"udid": "213736f9c729aac9f31869966cbaf91d961f953798b97f65390c82c017e36274",
"clientVersion": "1.1.1.1",
"ramTotal": 1000,
"ramFree": 150,
"iccid": "2982 6527 0753 2084 525"
} ]
}
Get all the devices .
GET / SRP00000 / api / v1 / devices
{
"devices": [
{
"links": [
{
"rel": "userDevice",
"href": "https://server01:18084/SRP00000//api/v1/users/0d3bcd79-b3da-44d1-9c23-48eac996fa7c/userDevices/ceb68aa6-6025-4bdb-b049-c915fba5e6db"
}
],
"sims": [
{
"phoneNumber": "919392657",
"imei": "35 720209 854331 2",
"iccid": "8991 4922 7770 6465 771",
"homeCarrier": "IND airtel",
},
{
"phoneNumber": "992657677",
"imei": "35 376369 238556 6",
"iccid": "8991 8540 4005 8782 4802",
"homeCarrier": "Jio 4G",
"eSIM": "89049032007108882600142836905105"
}
],
"guid": "7e320dcb-8e4d-49ad-b5a6-b4d57307805f",
"activationDate": "2023-05-26T17:34:01.805Z",
"activeSyncId": "FF9V31HLFL7HN8JFD20ADD3IJ0",
"batteryLevel": 87.0,
"compromised": false,
"hardwareModel": "iPhone XS",
"hardwareName": "iPhone11,2",
"hardwareVendorCompanyName": "Apple Inc",
"homeCarrier": "IND airtel",
"iccid": "8991 4922 7770 6465 771",
"internalStorageFree": 52158.0,
"internalStorageSize": 65536.0,
"imei": "35 720209 854331 2",
"meid": "35720209850331",
"acquireLogs": "UNKNOWN",
"os": "iOS 16.3.1",
"osFamilyName": "ios",
"osVersion": "16.3.1",
"ownership": "UNKNOWN",
"phoneNumber": "919392657",
"serialNumber": "G0NXV8U0KPFP",
"udid": "00008020-000630C83ED8003A",
"wifiMacAddress": "90:e1:7b:bb:16:90",
"ramTotal": 4096,
"supervised": false
}
]
}
| Name | Location | Description | Type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| includeTotal | query | If you want the total number of devices matching the search included in the response (which may be different from the number of devices actually returned) set this to true; otherwise set to false. By default the total will not be included in the response. | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| max | query | The maximum number of device results to get, between 1 and 1000 inclusive. If not specified, a value of 100 will be used. | int | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| offset | query | The number of matching devices to exclude from the beginning of the list of devices in the response; greater
than or equal to 0. If not specified, a value of 0 will be used to indicate that no matches should be excluded.
Used in order to get "pages" of results. For example, to get the first 50 matching devices, specify
max=50 (and optionally offset=0); and to get the next 50 matching devices specify
max=50 and offset=50, and so on. |
int | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| query | query | Query parameter for filtering the results. The format is <field name>=<query value>,
for example imei=990000862471854. Multiple field-value pairs can be provided in the query with each
pair separated with a comma, in which case only devices matching all of the criteria provided will
be included in the response. Querying for empty/null values is not supported.
By default, a case-insensitive exact match will be performed for each field in the query. For fields that
support prefix (i.e. starts with) matching, append an asterisk ("*") to the end of the value. To match an
asterisk at the end of a string instead of prefix matching, the asterisk must be escaped with a backslash.
Special characters (comma, backslash) in query values must be escaped with a backslash.
The following table describes the fields that can be used in the query.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sortBy | query | The field to sort the device results by. The format is <field name> ASC|DESC, where
ASC means to sort the results in ascending order and DESC means descending order. For
example, to sort the results by OS in descending order, specify os DESC. If not specified, a value
of hardwareModel ASC will be used. The following fields are allowed: hardwareModel, osFamilyName,
os. |
| Code | Condition | Data type |
|---|---|---|
| 200 | OK (even if no devices are found). |
|
| 400 | Invalid search query. |
|
| Media type | Data type | Description |
|---|---|---|
| application/vnd.blackberry.devices-v1+json | Devices (JSON) |