Logo

AndroidDevice

APIs for android device management

Find out more about device management

Fetch all devices in an enterprise

Returns a list of devices

SecurityapiKey
Request
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 <int32> (DeviceStateEnum)

Following are the Device States and their description

* 0 = Device State is Unspecified
* 1 = Online
* 20 = Disabled (device has been factory reset or removed from the Esper Dashboard)
* 30 = Beginning Provisioning
* 40 = Configuring Google Play (still provisioning)
* 50 = Applying Policies and Installing Applications (still provisioning)
* 60 = Offline
* 70 = Device is undergoing a Factory Reset (reset started from Dashboard)
* 80 = Device Onboarding in Progress
* 90 = Device Onboarding Failed
* 100 = Device Onboarded in Esper
* 110 = Android For Work Account added
* 120 = Apps installed
* 130 = Branding Processed
* 140 = Permission Policy Processed
* 150 = Device Policy Processed
* 160 = Device Settings Processed
* 170 = Security Policy Processed
* 180 = Phone Policy Processed
* 190 = Custom Settings Processed
* 200 = Registered
Enum: 0 1 20 30 40 50 60 70 80 90 100 110 120 130 140 150 160 170 180 190 200
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

assigned_blueprint_id
string <uuid>

Filter by assigned blueprint id

current_blueprint_id
string <uuid>

Filter by current blueprint id

current_blueprint_version_id
string <uuid>

Filter by current blueprint version id

limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

Return results from this index.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/enterprise/{enterprise_id}/device/
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}
Fetch device details by ID
Returns details of a device


SecurityapiKey 
Request 
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}/
Request samples 
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",
  • "directory_record_id": "6f311904-88c6-4ec4-a47d-9093f673ceea",
  • "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,
  • "kiosk_app_name": "string",
  • "lockdown_state": 0,
  • "timezone_string": "string",
  • "initialtemplate": "string",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "emm_device": {
    },
  • "is_gms": true,
  • "is_active": true,
  • "has_seamlessInfo": true
}
List all device apps
Returns DeviceApp list


SecurityapiKey 
Request 
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


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


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


SecurityapiKey 
Request 
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


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/{enterprise_id}/device/{device_id}/app/{app_id}/
Request samples 
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,
  • "is_kiosk_app": true,
  • "is_esper_controlled": true,
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd"
}
List installed apps
Returns AppInstall list


SecurityapiKey 
Request 
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


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/{enterprise_id}/device/{device_id}/install/
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}
Get latest device event
Returns DeviceStatus instance


SecurityapiKey 
Request 
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
Returns the latest event. Must be set to 1.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/{enterprise_id}/device/{device_id}/status/
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}
Download Event Feed for Device
Download Event Feed for device, ordered by date the event was created on


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string
A UUID string identifying this enterprise.


 
device_id
required
string
A UUID string identifying the device


 
query Parameters
limit
integer
 Default:  250
Number of results to return per page.


 
offset
integer
 Default:  0
Return results from this index.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


500
Internal server error


get/enterprise/{enterprise_id}/device/{device_id}/download/eventfeed/
Request samples 
Response samples 
application/json
{}
Download Event Feed for Group
Download Event Feed for group, ordered by date the event was created on


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string
A UUID string identifying this enterprise.


 
group_id
required
string
A UUID string identifying the group


 
query Parameters
limit
integer
 Default:  250
Number of results to return per page.


 
offset
integer
 Default:  0
Return results from this index.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


500
Internal server error


get/enterprise/{enterprise_id}/group/{group_id}/download/eventfeed/
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}
Lists event feed for device
Returns event feed for device, ordered by date the event was created on


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string
A UUID string identifying this enterprise.


 
device_id
required
string
A UUID string identifying the device


 
query Parameters
limit
integer
 Default:  20
Number of results to return per page.


 
offset
integer
 Default:  0
Return results from this index.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


500
Internal server error


get/v1/enterprise/{enterprise_id}/device/{device_id}/report/eventfeed/
Request samples 
Response samples 
application/json
{}
Get last seen details of the device
SecurityapiKey 
Request 
path Parameters
device_id
required
string <uuid> 
ID of the device


 
Responses 
200
Last seen details of the device


400
Bad Request


401
Authorization information is missing or invalid.


404
Not found


500
Internal Server Error


get/device/v0/heartbeat/{device_id}/
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}
➔ Next to Device Group