ICCID not included in device report export: retrieve via API using networkInfo object
Android
The device report export in the Esper Console does not include the ICCID (Integrated Circuit Card Identifier) field. If you need to retrieve ICCID data for devices with active SIM cards, you can use the Esper API to access this information through the networkInfo object.
Before you begin
You'll need:
- Your Enterprise ID
- An API Bearer Token
- Access to your API endpoint URL
You can obtain your Enterprise ID and API Bearer Token from Settings → API Key Management in the Esper Console.
How to retrieve ICCID via the API
- Gather your Enterprise ID, API Bearer Token, and endpoint URL from Settings → API Key Management.
- Run the following API call to retrieve up to 100 devices with full metadata:
Replacecurl -X GET "https://<endpoint>-api.esper.cloud/api/enterprise/<enterprise-id>/device/?show_device_metadata=true&limit=100" \ -H "Authorization: Bearer <API-token>" \ -H "Content-Type: application/json"<endpoint>with your tenant subdomain,<enterprise-id>with your enterprise ID, and<API-token>with your API Bearer Token. - In the JSON response, locate the
networkInfoobject for each device. The ICCID field is available within this object for devices with an active SIM card. - If your fleet has more than 100 devices, the response will include a
"next"field with a URL to retrieve the next page of results. Repeat the request using that URL until"next"returnsnull. - Extract the
networkInfo.iccidvalues alongside device identifiers (such as serial number or device name) to build your complete ICCID inventory. - Verify that at least one device with a known active SIM shows a populated ICCID value in the
networkInfoobject.
Troubleshooting
The networkInfo object is empty or ICCID is null:
- Confirm the device has an active SIM card inserted and is online. ICCID data is only populated for devices with an active SIM.
The API returns no networkInfo object:
- Ensure the
show_device_metadata=trueparameter is included in your API request.
Received 401 Unauthorized error:
- Regenerate your API token from Settings → API Key Management in the Esper Console and try again.
Important notes
- ICCID is only available for devices with an active SIM card installed. Devices without a SIM will not have this field populated.
- The
limitparameter maximum per request is100devices. For larger fleets, use pagination via thenextURL field in the response. - This API call is read-only and does not modify any device configuration.
- The API endpoint format is
https://<tenant-subdomain>-api.esper.cloud. Ensure you are using the correct endpoint URL for your tenant.
Still need help?
If you need further assistance, contact Esper Support.
0
Please sign in to leave a comment.
Comments
0 comments