Skip to content

Fetch all devices in an enterprise
Stable

Request

Returns a list of devices

Security
apiKey
Path
enterprise_idstring, (uuid)required

ID of the enterprise

Query
namestring

filter by device name

groupstring, (uuid)

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

imeistring

filter by imei

serialstring

filter by serial number

stateinteger, (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:012030405060708090
brandstring

filter by brand

is_gmsboolean

filter for gms devices

searchstring

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

tagsstring

A partial text search for device tags

assigned_blueprint_idstring, (uuid)

Filter by assigned blueprint id

current_blueprint_idstring, (uuid)

Filter by current blueprint id

current_blueprint_version_idstring, (uuid)

Filter by current blueprint version id

limitinteger

Number of results to return per page.

Default:20
offsetinteger

Return results from this index.

Default:0
cURL
curl -i -X GET \
  'https://develop-api.esper.io/_mock/openapi/enterprise/{enterprise_id}/device/?name=string&group=497f6eca-6276-4993-bfeb-53cbbbba6f08&imei=string&serial=string&state=0&brand=string&is_gms=true&search=string&tags=string&assigned_blueprint_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&current_blueprint_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&current_blueprint_version_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&limit=20&offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
countinteger, (int64)
nextstring, (url)
previousstring, (url)
resultsArray of objects(DeviceInfo)
Response
{
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
    { … }
  ]
}