Skip to main content
Get a list of devices.
External DocumentationTo learn more, visit the Device 42 documentation.

​
Basic Parameters

ParameterDescription
Device IDThe ID of the device to get details on.
FieldsList of fields to return for each device in the result.
LimitThe maximum number of objects to return in the response.
NameThe name of the device to filter the results by.
OffsetThe pagination offset indicating the starting point for the next set of results.

​
Advanced Parameters

ParameterDescription
AND TagsA comma-separated list of tags to filter by (AND related - return results that include all the tags).
Asset NumberAn asset number of a device to filter the results by.
Asset Number ContainsReturns only assets whose asset number contains the specified value.
Blade ChassisFilter by whether device is a blade chassis.
Cluster Device IDThe cluster device ID to filter by.
Custom Fields (AND)A comma-separated list of custom fields to filter the results by (AND). Format - key1:value1,key2:value2
Custom Fields (OR)A comma-separated list of custom fields to filter the results by (OR). Format - key1:value1,key2:value2
CustomerThe name of the customer to filter the results by.
Customer IDThe customer ID of the device to filter by.
First Added AfterFilter objects first added after or on the given date .
First Added BeforeFilter objects first added before the given date.
HardwareThe hardware name of the device to filter by.
Hardware IDThe hardware ID of the device to filter by.
Host Chassis Device IDThe host chassis device ID to filter by.
In ServiceWhether the device is in-service.
Last Edited AfterFilter devices last edited after the given date.
Last Edited BeforeFilter devices last edited before the given date.
OS IDThe ID of the operating system of the device to filter by.
OS NameThe operating system name of the device to filter by.
Object CategoryThe object category name of the device to filter by.
Object Category IDThe object category ID of the device to filter by.
Physical SubtypeThe physical subtype name of the device to filter by.
Physical Subtype IDThe physical subtype ID of the device to filter by.
Rack IDThe rack ID of the device to filter by.
Serial NumberSerial number of a device to filter the results by.
Serial Number ContainsA part of the device serial number to filter the results by.
Service LevelThe service level of the device to filter by.
Service Level IDThe ID of the service level of the device to filter by.
TagsA comma-separated list of tags to filter results by (OR filter - return results that include at least one of the tags).
TypeThe type of the device to filter by.
Type IDThe ID of the type of the device to filter by.
UUIDThe unique ID to filter the results by.
Virtual HostFilter by whether device is a virtual host.
Virtual Host Device IDThe virtual host device ID to filter by.
Virtual SubtypeThe virtual subtype name of the device to filter by.
Virtual Subtype IDThe virtual subtype ID of the device to filter by.

​
Example Output

{
	"Devices": {
		"total_count": "709",
		"limit": "1",
		"devices": [
			{
				"name": "Device_Name",
				"type_id": 2,
				"serial_no": "FOC1252W6EW",
				"asset_no": "123456",
				"device_url": "/api/2.0/devices/64/",
				"device_id": "64",
				"type": "physical",
				"uuid": ""
			}
		],
		"offset": "0"
	}
}

​
Workflow Library Example

List Devices with Device 42 and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop