Sign in
Devices

List devices

Returns a paginated list of the user's devices along with pagination metadata.

get/devices

Query parameters

statestring[] nullable
type'android_cloud_phone' | 'dedicated_premium_device' | 'dedicated_physical_device' | 'dedicated_ios_device' | 'dedicated_emulated_device'

Deprecated device type aliases are accepted during a compatibility grace period: dedicated_premium_device maps to android_cloud_phone, dedicated_physical_device maps to android_physical_phone, dedicated_ios_device maps to ios_stealth_phone, and dedicated_emulated_device maps to android_emulator.

Deprecated device type aliases are accepted during a compatibility grace period: dedicated_premium_device maps to android_cloud_phone, dedicated_physical_device maps to android_physical_phone, dedicated_ios_device maps to ios_stealth_phone, and dedicated_emulated_device maps to android_emulator.

countrystring
namestring
providerIdstring
mineboolean

When true, only return devices created by the calling user (resolved from X-User-ID, never a client-supplied id).

When true, only return devices created by the calling user (resolved from X-User-ID, never a client-supplied id).

createdBystring

Filter to devices created by this user id. Mutually exclusive with mine.

Filter to devices created by this user id. Mutually exclusive with mine.

pageinteger
pageSizeinteger
orderBy'id' | 'createdAt' | 'updatedAt' | 'assignedAt'
orderByDirection'asc' | 'desc'

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

Example response

{
  "$schema": "https://example.com/schemas/ResponseDeviceInfo.json",
  "items": [
    {
      "$schema": "https://example.com/schemas/DeviceInfo.json"
    }
  ]
}

Changes