# Device Attributes ### `POST /m2m/v1/devices/actions/list` This endpoint returns all of the device's details based on its 20-digit Integrated Circuit Card ID (ICCID). ## Header Parameters The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit [Getting Started](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/guides/getting-started/introduction-to-the-connectivity-management-api). |Parameter Name|Data Type|Description| |-----|-----|-----| | **Authorization** *(required)* | string | HTTP Authorization request header containing a valid Bearer token: `Authorization: Bearer {token}` | | **VZ-M2M-Token** *(required)* | string | A valid session token returned by a Connectivity Management `POST /session/login` request. | | **Content-Type** *(required)* | string | Must be `application/json`. | ## HTTP Request [POST https://thingspace.verizon.com/api/m2m/v1/devices/actions/list](/docs/standard-apis/5g-business-internet/api-endpoints/businessinternetlistdeviceinformation) ## Request Parameters | Parameter | Data Type | Description | | ---------- | --------- | ------------ | | **deviceId** *(required)* | object | The `deviceId` object contains the `id` and `kind` of the device identifier used in the query. The query requires the Integrated Circuit Card ID (**ICCID**) value. | ## Request Body Example Request Body ```json "deviceId": { "id": "20-digit ICCID", "kind": "iccid" } ``` ## Success Responses **Status 200** ```json { "hasMoreData": false, "devices": [ { "accountName": "0000123456-00001", "billingCycleEndDate": "2022-11-10T00:00:00Z", "carrierInformations": [ { "carrierName": "Verizon Wireless", "state": "deactive" } ], "connected": false, "createdAt": "2022-10-20T18:23:41Z", "customFields": [ { "key": "CustomField1", "value": "CF271" }, { "key": "CustomField2", "value": "CF272" }, { "key": "CustomField3", "value": "CF273" }, { "key": "CustomField4", "value": "CF274" }, { "key": "CustomField5", "value": "CF275" } ], "deviceIds": [ { "id": "15 digit IMSI", "kind": "imsi" }, { "id": "15-digit IMEI", "kind": "imei" }, { "id": "20-digit ICCID", "kind": "iccId" } ], "extendedAttributes": [ { "key": "PrimaryPlaceOfUseTitle" }, { "key": "PrimaryPlaceOfUseFirstName", "value": "string" }, { "key": "PrimaryPlaceOfUseMiddleName" }, { "key": "PrimaryPlaceOfUseLastName", "value": "string" }, { "key": "PrimaryPlaceOfUseSuffix" }, { "key": "PrimaryPlaceOfUseAddressLine1", "value": "string" }, { "key": "PrimaryPlaceOfUseAddressLine2" }, { "key": "PrimaryPlaceOfUseCity", "value": "string" }, { "key": "PrimaryPlaceOfUseState", "value": "2-character state code" }, { "key": "PrimaryPlaceOfUseCountry", "value": "USA" }, { "key": "PrimaryPlaceOfUseZipCode", "value": "string" }, { "key": "PrimaryPlaceOfUseZipCode4" }, { "key": "PrimaryPlaceOfUseCBRPhone" }, { "key": "PrimaryPlaceOfUseCBRPhoneType" }, { "key": "PrimaryPlaceOfUseEmailAddress" }, { "key": "AccountNumber", "value": "0000123456-00001" }, { "key": "SmsrOid" }, { "key": "ProfileStatus" }, { "key": "SkuNumber", "value": "VZW080000250071" }, { "key": "CostCenterCode", "value": "" }, { "key": "PreIMEI", "value": "15-digit IMEI" }, { "key": "PreSKU", "value": "VZW080000250071" }, { "key": "SIMOTADate", "value": "2022-11-02T21:39:55Z" }, { "key": "RoamingStatus", "value": "Unavailable" } ], "groupNames": [ "Default: 0000123456-00001" ], "ipAddress": "0.0.0.0", "lastActivationBy": "user name", "lastActivationDate": "2022-11-02T21:36:18Z" } ] } ``` ## Success Parameters |Parameter Name|Data Type|Description| |-----|-----|-----| | **hasMoreData** | boolean | Indicates if there is more than one page of data returned: **true** - more than one page of data, **false** - all data is displayed. | | **devices** | array | An array of device property objects including the device ID, the address of the device and account information. | | **accountName** | string | The numeric name of the account the device is associated with. | | **billingCycleEndDate** | string ($date-time) | The system-assigned date of the end of the device's billing cycle. | | **carrierInformations** | array | An array of objects showing the service providers name (`carrierName`) and the status (`state`) of the device on that service provider's network (**pending**, **active** or **deactive**). | | **connected** | boolean | Indicates if the device is currently connected to a servie provider's network (**true**) or not (**false**). | | **createdAt** | string ($date-time) | Timestamp for when the device's record was created. | | **customFields** | array | An array of custom fields that can be used as additional descriptors. Valid key values are: `CustomField1`, `CustomField2`, `CustomField3`, `CustomField4`, and `CustomField5`. The `value` can contain any combination of alpha, numeric or special characters.| | **deviceIds** | array | An array of objects listing the identifying values of the device where `kind` can be **imei**, **imsi** or **iccid** and `id` is the value of the corresponding `kind`. | | **extendedAttributes** | array | An array of the device's address and additional account attributes where `key` is the name of the attribute and `value` is the information defining the `key`. Since not all of the `key` values are required to be defined, the response will either show no `value` or a null.| | **groupNames** | string | The user defined groups the device is associated with. | | **ipAddress** | string | This will show an assigned IP address if the device is activated as Public Static. | | **lastActivationBy** | string | The user name of the device's activator. | | **lastActivationDate** | string ($date-time) | The time stamp of the device's activation. | ## Failure Responses All error messages are returned in this format: ```json { "errorCode": "error code string", "errorMessage": "error message string" } ```