ICCID missing from device report export — retrieve via Esper API
Android
When exporting a device report from the Esper Console, the ICCID (Integrated Circuit Card Identifier) field is not included in the export file, even for devices with active SIM cards.
Why this happens
The device report export does not surface all metadata fields stored against a device. ICCID is available in the device metadata layer and must be retrieved directly through the Esper API using the networkInfo object.
What you need before you start
- Your Enterprise ID
- An API Bearer Token
- Your tenant API endpoint URL (format:
https://<tenant-subdomain>-api.esper.cloud)
Retrieve all three from Settings → API Key Management in the Esper Console.
Steps
- Open API Key Management by navigating to Settings → API Key Management in the Esper Console. Copy your Enterprise ID, API Bearer Token, and note your tenant endpoint URL.
-
Run the following API call to retrieve up to 100 devices with full metadata, including the
networkInfoobject:
Replacecurl -X GET "https://<tenant-subdomain>-api.esper.cloud/api/enterprise/<enterprise-id>/device/?show_device_metadata=true&limit=100" \ -H "Authorization: Bearer <API-token>" \ -H "Content-Type: application/json"<tenant-subdomain>,<enterprise-id>, and<API-token>with your actual values. Theshow_device_metadata=trueparameter is required — without it, thenetworkInfoobject is not returned. -
Locate the
networkInfoobject in the JSON response for each device. The ICCID value appears asnetworkInfo.iccidand is only populated for devices with an active SIM card inserted. -
Handle pagination if your fleet has more than 100 devices. The response includes a
"next"field containing the URL for the next page of results. Repeat the request using that URL until"next"returnsnull, which indicates all devices have been retrieved. - Extract the ICCID values alongside device identifiers such as serial number or device name to build a complete ICCID inventory for your fleet.
Verify: At least one device with a known active SIM card should return a populated networkInfo.iccid value in the response. Devices without a SIM will have this field empty or null — this is expected behavior.
Troubleshooting
-
networkInfois empty oriccidisnull: Confirm the device has an active SIM card inserted and is currently online. ICCID is only populated when a SIM is present and active. -
No
networkInfoobject appears in the response: Verify thatshow_device_metadata=trueis included as a query parameter in the request URL. -
401 Unauthorizederror: Regenerate your API Bearer Token from Settings → API Key Management in the Esper Console, then retry the request with the new token.
If this doesn't resolve it
If the networkInfo object is consistently empty for devices you have confirmed are online with active SIMs, contact Esper Support with the following information:
- The affected device serial numbers or Esper device IDs
- The full API response body (with your token redacted)
- Confirmation of the Android OS version running on the affected devices
Still need help?
Still can't retrieve the ICCID data you need? Submit a support ticket and include your Device ID, the specific report format you're exporting, and whether you're using the API or the Esper console.
Please sign in to leave a comment.
Comments
0 comments