Skip to content

Get all devices in the tenant

Request

Returns all the devices in the tenant

Security
apiKey
Query
limitinteger, <= 1000
Default:10
offsetinteger
cursorstring

Opaque cursor token for cursor-based pagination.

  • Use start to begin from the first page
  • Use the next_cursor value from previous response for subsequent pages
  • Use the prev_cursor value from previous response to navigate backward
  • When provided, offset parameter is ignored
Example:cursor=start
orderingstring

Field to order the results by. Prefix with '-' to reverse the order.

Enum:"alias""created_at""last_seen""model""os_version""name""serial""provisioned_on""battery_level""dpc_version"
serialstring
udidstring
android_versionstring
ios_versionstring
ipados_versionstring
tvos_versionstring
windows_versionstring
statestring
battery_level_gtestring
battery_level_ltestring
is_gmsboolean
active_connectionstring
group_multistring, (uuid)

Filter by multiple group ID. Fetch the devices from groups matching with the IDs and its subgroup.

group_multi_immediatestring, (uuid)

Filter by multiple group IDs. Fetch the devices from groups matching with the IDs. Excludes devices in any subgroups.

assigned_blueprint_idstring, (uuid)
current_blueprint_idstring, (uuid)
current_blueprint_version_idstring, (uuid)
current_blueprint_version_id_netstring, (uuid)
platformstring

a csv list of platforms [ANDROID, APPLE, LINUX, WINDOWS]

osstring
Enum:"iOS""iPadOS""tvOS""Android""Linux""Windows"
device_sourcestring

a csv list of device sources [ABM, NON_ABM]

managed_bystring
Enum:"BLUEPRINT""TEMPLATE"
template_multistring

a csv list of template names

policy_multistring

a csv list of policy names

searchstring

Search devices by multiOS -> Name, Serial, IMEI, Model, WiFi SSID, Apple UDID, ICCID1, ICCID2, Brand, Manufacturer, Hardware, WiFi MAC Address, SIM Operator, Network Operator and IP Address.

foundation_device_model_idstring, (uuid)
android_version_exactstring
foundation_major_versioninteger
foundation_minor_versioninteger
foundation_build_numberinteger
airwave_tenant_model_idstring
airwave_build_idstring
airwave_build_numberinteger
foundation_versionstring

Full foundation version string (either os_version.major.minor.build or eea_version)

esper_agent_version_namestring

Filter devices by Esper agent version name (DPC version)

tagsstring

a csv list of tag ids

is_locked_downboolean
global_device_idstring
cURL
curl -i -X GET \
  'https://develop-api.esper.io/_mock/openapi/v2/devices/?limit=10&offset=0&cursor=start&ordering=alias&serial=string&udid=string&android_version=string&ios_version=string&ipados_version=string&tvos_version=string&windows_version=string&state=string&battery_level_gte=string&battery_level_lte=string&is_gms=true&active_connection=string&group_multi=497f6eca-6276-4993-bfeb-53cbbbba6f08&group_multi_immediate=497f6eca-6276-4993-bfeb-53cbbbba6f08&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&current_blueprint_version_id_net=497f6eca-6276-4993-bfeb-53cbbbba6f08&platform=string&os=iOS&device_source=string&managed_by=BLUEPRINT&template_multi=string&policy_multi=string&search=string&foundation_device_model_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&android_version_exact=string&foundation_major_version=0&foundation_minor_version=0&foundation_build_number=0&airwave_tenant_model_id=string&airwave_build_id=string&airwave_build_number=0&foundation_version=string&esper_agent_version_name=string&tags=string&is_locked_down=true&global_device_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Device information for the Tenant. Response format depends on pagination type used:

  • Offset-based: Returns count, prev, next (URLs), results
  • Cursor-based: Returns results, next_cursor, prev_cursor
Bodyapplication/json
contentOffsetPaginatedDeviceList (object) or CursorPaginatedDeviceList (object)
One of:

Response format for offset-based pagination

Response
{
  "content": {
    "count": 0,
    "previous": "string",
    "next": "string",
    "results": [ … ]
  }
}