Device

APIs for device management

Fetch all devices in an enterprise

Returns a list of devices

Request
Security:
path Parameters
enterprise_id
required
string <uuid>

ID of the enterprise

query Parameters
name
string

filter by device name

group
string <uuid>

filter by group id. It will list all the devices under this gorup including the subgroups

imei
string

filter by imei

serial
string

filter by serial number

state
integer

filter by device state

brand
string

filter by brand

is_gms
boolean

filter for gms devices

search
string

A search term. Search by device name, imei or mac address

tags
string

A partial text search for device tags

limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

Return results from this index.

Responses
200

successful operation

get/enterprise/{enterprise_id}/device/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Fetch device details by ID

Returns details of a device

Request
Security:
path Parameters
enterprise_id
required
string <uuid>

ID of the enterprise

device_id
required
string <uuid>

ID of the device

Responses
200

successful operation

400

Bad request

get/enterprise/{enterprise_id}/device/{device_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "url": "string",
  • "device_name": "string",
  • "alias_name": "string",
  • "policy_name": "string",
  • "status": 0,
  • "state": 0,
  • "current_command": "56d48fe1-418b-4f15-89fd-e796ac9dcba7",
  • "suid": "string",
  • "fcm_id": "string",
  • "enterprise": "string",
  • "policy": "string",
  • "user": "string",
  • "groups": [
    ],
  • "tags": [
    ],
  • "api_level": 0,
  • "template_name": "string",
  • "mqtt_id": "string",
  • "softwareInfo": { },
  • "hardwareInfo": { },
  • "displays": { },
  • "networkInfo": { },
  • "memoryInfo": { },
  • "esper_cient": "string",
  • "device_type": "string",
  • "audioConstraints": { },
  • "provisioned_on": "2019-08-24T14:15:22Z",
  • "created_on": "2019-08-24T14:15:22Z",
  • "current_app_mode": 0,
  • "lockdown_state": 0,
  • "timezone_string": "string",
  • "initialtemplate": "string",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "emm_device": {
    },
  • "is_gms": true,
  • "is_active": true
}

List all device apps

Returns DeviceApp list

Request
Security:
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

device_id
required
string

A UUID string identifying device.

query Parameters
package_name
string

Filter by Package name

whitelisted
string

Whitelist filter

search
string

A search term. Search by app_name.

limit
integer
Default: 20

Number of results to return per page.

offset
integer

Return results from this index.

Responses
200

successful operation

get/enterprise/{enterprise_id}/device/{device_id}/app/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Get device app details

Returns DeviceApp instance

Request
Security:
path Parameters
app_id
required
string <uuid>

A UUID string identifying this device app.

enterprise_id
required
string

A UUID string identifying this device.

device_id
required
string

A UUID string identifying this enteprise.

Responses
200

successful operation

get/enterprise/{enterprise_id}/device/{device_id}/app/{app_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "app_name": "string",
  • "state": "string",
  • "app_type": "string",
  • "package_name": "string",
  • "whitelisted": true,
  • "is_data_clearable": true,
  • "is_uninstallable": true,
  • "product_id": "string",
  • "version_code": "string",
  • "version_name": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd"
}

List installed apps

Returns AppInstall list

Request
Security:
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

device_id
required
string

A UUID string identifying device.

query Parameters
device
string

filter by device id

package_name
string

filter by package name

application_name
string

filter by application name

install_state
string

filter by install state

limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

Return results from this index.

Responses
200

successful operation

get/enterprise/{enterprise_id}/device/{device_id}/install/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Get latest device event

Returns DeviceStatus instance

Request
Security:
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

device_id
required
string

A UUID string identifying device.

query Parameters
latest_event
required
integer

Flag to get latest event

Responses
200

successful operation

get/enterprise/{enterprise_id}/device/{device_id}/status/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}