Verizon 5G Edge API Portal
Verizon 5G EdgeThingSpace
HomeSDKsContext PluginAPI Reference
Device Management

Returns information about a specified device or a list of devices in an account.

POST
/m2m/v1/devices/actions/list

Returns information about a single device or information about all devices that match the given parameters. Returned information includes device provisioning state, service plan, MDN, MIN, and IP address.

Authorization

thingspace_oauth VZ-M2M-Token
AuthorizationBearer <token>

This is the ThingSpace token, from Credentials and Tokens is used

In: header

VZ-M2M-Token<token>

M2M Session Token (How to generate an M2M session token?)

In: header

Request Body

application/json

Device information query.

Device information query.

accountName?string

The billing account for which a list of devices is returned. If you don't specify an accountName, the list includes all devices to which you have access.

deviceId?

An identifier for a single device.

filter?

Filter for a list of devices.

currentState?string

The name of a device state, to only include devices in that state.

customFields?array<>

Custom field names and values, if you want to only include devices that have matching values.

earliest?string

Only include devices that were added after this date and time.

groupName?string

Only include devices that are in this device group.

latest?string

Only include devices that were added before this date and time.

servicePlan?string

Only include devices that have this service plan.

maxNumberOfDevices?integer
Formatint32
Range0 <= value <= 500
largestDeviceIdSeen?integer
Formatint64
Range0 <= value <= 0

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/m2m/v1/devices/actions/list" \  -H "Content-Type: application/json" \  -d '{    "deviceId": {      "id": "20-digit ICCID",      "kind": "iccid"    }  }'
{  "hasMoreData": false,  "devices": [    {      "accountName": "0000123456-00001",      "billingCycleEndDate": "2020-05-09T20:00:00-04:00",      "carrierInformations": [        {          "carrierName": "Verizon Wireless",          "servicePlan": "m2m4G",          "state": "active"        }      ],      "connected": false,      "createdAt": "2019-08-07T10:42:15-04:00",      "deviceIds": [        {          "id": "10-digit MDN",          "kind": "mdn"        },        {          "id": "15-digit IMEI",          "kind": "imei"        }      ],      "groupNames": [        "southwest"      ],      "ipAddress": "0.0.0.0",      "lastActivationBy": "Joe Q Public",      "lastActivationDate": "2019-08-07T10:42:34-04:00",      "lastConnectionDate": "2020-03-12T04:23:37-04:00"    }  ]}

Deletes up to 200 deactive devices. POST

Use this API to remove unneeded devices from an account.

Returns a list of all 4G devices with an ICCID that was not activated with the expected IMEI. POST

Returns a list of all 4G devices with an ICCID (SIM) that was not activated with the expected IMEI (hardware) during a specified time frame.