List Phones - BlinkOps Documentation

Retrieve a list of phones. To fetch all results, run repeatedly with the Offset parameter as long as the result metadata has a next_offset value. If no Number or Extension parameters are provided, the list will contain all phones. Otherwise, the list will contain either a single phone (if a match was found), or no phones. Note: This action requires the Grant resource - Read API permission.

External DocumentationTo learn more, visit the Duo documentation.

Basic Parameters

Parameter	Description
Phone Number	Specify a phone number (in `E.164` format) to look up a single phone.

Advanced Parameters

Parameter	Description
Extension	The phone extension.
Limit	The maximum number of phones to retrieve. Defaults to `100` with a maximum of `500`.
Offset	The offset from 0 at which to start record retrieval. When used with `Limit`, the handler will return `limit` records starting at the n-th record, where `n` is the offset. Defaults to `0`.

Example Output

{
	"metadata": {
		"total_objects": 1
	},
	"response": [
		{
			"activated": false,
			"capabilities": [
				"sms"
			],
			"encrypted": "Unknown",
			"extension": "",
			"fingerprint": "Unknown",
			"last_seen": "",
			"model": "Unknown",
			"name": "test-phone",
			"number": "+12142144286",
			"phone_id": "DPERLUZ8CIO49STDMKDP",
			"platform": "Google Android",
			"screenlock": "Unknown",
			"sms_passcodes_sent": false,
			"tampered": "Unknown",
			"type": "Mobile",
			"users": []
		}
	],
	"stat": "OK"
}