Retrieve the Global Device List (eUICC)

Retrieve the Global Device List (for eUICC)

POST /v2/devices/actions/list

Retrieves a list of all devices on an account.

Contents

Request Components

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.

Parameter Name Data Type Description
Authorization
required
string

HTTP Authorization bearer token:
Authorization: Bearer {token}

VZ-M2M-Token
required
string

A valid session token:
VZ-M2M-Token: {M2Mtoken}

Content-Type
required
string

Must be application/json:
Content-Type: application/json

HTTP Request

POST https://thingspace.verizon.com/m2m/v2/devices/actions/list

Request Parameters

Parameter Data Type Description
accountName
required
string The name of the account.
provisioningStatusFilter string

Filter by provisioning status. Values include:

  • DEACTIVATED
  • ACTIVATED
  • DEACTIVE
  • ACTIVE
  • SUSPEND
  • PENDING_ACTIVATION
  • PENDING_DEACTIVATION
  • PRE_ACTIVE
  • ACTIVATION_READY
  • INVENTORY
  • PURGED
  • REPLACED
  • RETIRED
  • TEST_READY
  • UNKNOWN
profileStatusFilter
string

Filter by profile status. Values include:

  • DISABLE
  • ENABLE
  • DOWNLOAD_DISABLE
  • DOWNLOAD_ENABLE
  • NOT_DOWNLOADED
  • UNKNOWN
  • DELETE
carrierName string The carrier providing cellular network access.
devices
array

An array of deviceIds. Each deviceId will contain:

  • id
  • kind
   id
string The numeric ID of the device.
   kind
string

The the type of device ID represented by the ID value. This could be:

  • imei
  • iccid
  • mdn
  • eid

Request Body

Example request:

{
   "accountName":"4 3TOM HPN2 S",
   "provisioningStatusFilter":"ACTIVE",
   "profileStatusFilter":"UNKNOWN",
   "carrierNameFilter":"Verizon Wireless",
   "deviceFilter":[
      {
         "id":"990001131241920",
         "kind":"imei"
      },
      {
         "id":"376456789123456789123456782019",
         "kind":"eid"
      }
   ]
}

Success Response

Status 200

A successful response shows a system generated request ID to track the request.

Example Response:

{
  "requestId": "d1f08526-5443-4054-9a29-4456490ea9f8"
}

Callback Response

These endpoints send responses asynchronously. In order to read the results a callback is required.To learn more about callback, please visti About Callback Services.

Example callback response:

{
   "requestId":"0cb74b9a-ef2f-4e16-a108-4b3a37417832",
   "deviceResponse":{
      "getDeviceListWithProfiles":{
         "complete":true,
         "total":1,
         "results":[
            {
               "accountName":"2143213217-55732",
               "profiles":[
                  {
                     "carrierInformation":{
                        "carrierName":"VerizonWireless",
                        "servicePlan":"TagTeam"
                     },
                     "billingCycleEndDate":"2021-08-31T11:59:59.0000000Z",
                     "connected":false,
                     "createdAt":"2021-08-23T22:14:54.7700000Z",
                     "profileIdentifiers":[
                        {
                           "kind":"iccid",
                           "identifier":"89148000006387470265"
                        },
                        {
                           "kind":"imsi",
                           "identifier":"311480616350299"
                        },
                        {
                           "kind":"mdn",
                           "identifier":"7588258970"
                        },
                        {
                           "kind":"msisdn",
                           "identifier":"17588258970"
                        }
                     ],
                     "extendedAttributes":[
                        {
                           "key":"PrimaryPlaceOfUseFirstName",
                           "value":"Yatharth"
                        },
                        {
                           "key":"PrimaryPlaceOfUseMiddleName",
                           "value":"T"
                        },
                        {
                           "key":"PrimaryPlaceOfUseLastName",
                           "value":"Trivedi"
                        },
                        {
                           "key":"PrimaryPlaceOfUseSuffix",
                           "value":"Jr."
                        },
                        {
                           "key":"PrimaryPlaceOfUseAddressLine1",
                           "value":"1112"
                        },
                        {
                           "key":"PrimaryPlaceOfUseAddressLine2",
                           "value":"Madison"
                        },
                        {
                           "key":"PrimaryPlaceOfUseCity",
                           "value":"OAK PARK"
                        },
                        {
                           "key":"PrimaryPlaceOfUseState",
                           "value":"IL"
                        },
                        {
                           "key":"PrimaryPlaceOfUseCountry",
                           "value":"USA"
                        },
                        {
                           "key":"PrimaryPlaceOfUseZipCode",
                           "value":"60302"
                        },
                        {
                           "key":"PrimaryPlaceOfUseZipCode4",
                           "value":"0303"
                        },
                        {
                           "key":"PrimaryPlaceOfUseCBRPhone",
                           "value":"1234567890"
                        },
                        {
                           "key":"PrimaryPlaceOfUseEmailAddress",
                           "value":"abc@gmail.com"
                        }
                     ],
                     "groupNames":[
                        "Default: 2143213217-55732"
                     ],
                     "lastActivationBy":"Anton Shapin",
                     "lastActivationDate":"2021-08-23T22:14:56.0000000Z",
                     "lastConnectionDate":"",
                     "provisioningStatus":"active",
                     "profileStatus":"unknown"
                  }
               ],
               "extendedAttribute":[
                  {
                     "key":"AccountNumber",
                     "value":"2143213217-55732"
                  },
                  {
                     "key":"LeadId",
                     "value":"LEAD"
                  },
                  {
                     "key":"CustomerAddressLine1",
                     "value":"9868"
                  },
                  {
                     "key":"CustomerAddressLine2",
                     "value":"Scraton"
                  },
                  {
                     "key":"CustomerAddressCity",
                     "value":"San Diego"
                  },
                  {
                     "key":"CustomerAddressState",
                     "value":"Cali"
                  },
                  {
                     "key":"ServiceZipCode",
                     "value":"123"
                  },
                  {
                     "key":"DeviceId",
                     "value":"91520657"
                  }
               ],
               "deviceIdentifiers":[
                  {
                     "id":"891430746723265",
                     "kind":"imei"
                  },
                  {
                     "id":"89033024423200437801000000000265",
                     "kind":"eid"
                  }
               ]
            }
         ]
      }
   }
}

Callback Parameters

Parameter Data Type Description
requestId string The requestId being viewed. This is a system generated value from the request above.
deviceResponse
object Contains the getDeviceListWithProfiles.
   getDeviceListWithProfiles array Shows if the request is complete, how many records matched the request and the results of the request.
      accountName string The name of the account being queried.
      profiles array The profile information of the account and the devices matching the request.
      carrierInformation array The carrier name and service plan name for the profile.
         carrierName string The name of the carrier providing cellular network access.
         servicePlan string The service plan subscribed to. This drives billing rates for usage.
      billingCycleEndDate string($date-time) The timestamp used for the end of a billing period.
      connected string

I need to know what this is.

      createdAt string($date-time) The timestamp of the profile's creation.
      profileIdentifiers
array

The ID information for the device(s) in the profile. Each will contain:

  • identifier
  • kind
         identifier
string The numeric ID of the device.
         kind
string

The the type of device ID represented by the ID value. This could be:

  • imei
  • iccid
  • mdn
  • eid
      extendedAttributes array This is the priamry name, address, phone number and email address of the account holder.
      groupNames  array

Contains the names of the groups the profile is associated with.

      lastActivationBy string The user name that made the most recent change.
      lastActivationDate string($date-time) The timestamp of the most recent change.
      provisioningStatus string

Status of provisioning. Will be one of the following:

  • Active
  • Pending
  • Disable
  • Unknown
   extendedAttribute string

Alternate contact information for the account holder.

   deviceIdentifiers
array

An array of device identifiers being matched by the request. Each device identifier will contain:

  • id
  • kind
      id
string The numeric ID of the device.
      kind
string

The the type of device ID represented by the ID value. This could be:

  • imei
  • iccid
  • mdn
  • eid

Failure Responses

All error responses will be in the following format

{
  "errorCode": "The 3-digit HTML error code",
  "errorMessage": "string"
}